Mobile API Documentation

Get Buy List

Overview:

Get list of items and full details of a buy list
All parameters are mandatory with every API call.

There are two modes in which you can use this API.

  1. Get the complete buy list (shopping cart). For this provide Branch "0" and shipping "standard". This will also give you a list of customer branches.
  2. For purchase confirmation, you provide the selected customer branch. This API will show you the totals for the selected diamonds, either all, checked or one single diamond.


Input Parameters

Parameter Description
session_code String, as received from login API.
shipping_method String, either "standard" or "expedited"
branch_id Integer. Leave 0 if nothing selected, that will use the default.
diamond_ids Integer Array

Sample Request

HTTP JSON
Endpoint: https://mobapi.idexonline.com/buylist/api/v2.0/getbuylist
{
  "session_code": "MOB_20240523065727_1u1FnnB6vyD5MI6adfUa8b",
  "shipping_method": "standard",
  "branch_id": 21103,
  "diamond_ids": [
	387665879,
	380175681
  ]
}

Sample Response

JSON Data with HTTP Code 200
If all goes well, the response will be an HTTP 200 code and the response_code in the JSON will be 0.
{
  "result_info": {
	"response_code": 0,
	"response_description": ""
  },
  "results": {
	"buylist": {
	  "items_included": 2,
	  "delivery_branch_id": 21103,
	  "shipping_method_id": 1,
	  "total_buylist_diamond_total_price": 2738,
	  "total_buylist_diamond_natural_total_price": 2738,
	  "total_buylist_diamond_labgrown_total_price": 0,
	  "total_buylist_auth_fee": 15,
	  "total_buylist_trans_fee": 82.14,
	  "total_buylist_pay_fee": 30,
	  "total_buylist_shipping_price": 123.58,
	  "total_buylist_to_pay": 2753,
	  "diamonds": [
		{
		  "diamond_id": 387665879,
		  "diamond_total_price": 882,
		  "auth_fee": 5,
		  "trans_fee": 26.46,
		  "amount_to_pay": 913.46,
		  "item_type_id": 1,
		  "status_id": 1,
		  "shape": "Round",
		  "weight": 0.63,
		  "color_short": "G",
		  "clarity": "VVS1",
		  "lab": "EGL Other",
		  "grading_report_number": "1701361625",
		  "cut_grade_short": "EX",
		  "polish_short": "EX",
		  "symmetry_short": "EX",
		  "fluorescence_short": "SLT",
		  "note_end_customer_name": "Good Man",
		  "note_sales_person": "Moshe",
		  "note_customer_notes": "Make sure to get ready before next week"
		},
		{
		  "diamond_id": 380175681,
		  "diamond_total_price": 1856,
		  "auth_fee": 10,
		  "trans_fee": 55.68,
		  "amount_to_pay": 1921.68,
		  "item_type_id": 1,
		  "status_id": 1,
		  "shape": "Round",
		  "weight": 1,
		  "color_short": "H",
		  "clarity": "VS2",
		  "lab": "GIA",
		  "grading_report_number": "2377402307",
		  "cut_grade_short": "FR",
		  "polish_short": "EX",
		  "symmetry_short": "GD",
		  "fluorescence_short": "FNT",
		  "note_end_customer_name": "",
		  "note_sales_person": "",
		  "note_customer_notes": ""
		}
	  ]
	},
	"customer_branches": [
	  {
		"branch_id": 21103,
		"company": "IDEX QA1",
		"address": "Emek Hachula 42",
		"city": "Milano",
		"country": "Italy"
	  }
	]
  }
}
		


Test the API


Generate JSON Request



POST






© IDEX Online 2024   -   www.idexonline.com