Mobile API Documentation

My Sales

Overview: Gives list of sales of the customer.
All parameters are mandatory with every API call.

Input Parameters

Parameter Description
session_code String, as received from login API.
filter String, values: "", "in progress", "history"
result_limit Integer, for paging, max amount of items to return. Optional
result_offset Integer, for paging, how many items to skip. Optional.

Sample Request

HTTP JSON
Endpoint: https://mobapi.idexonline.com/transactions/api/v2.0/mysales
{
  "session_code": "MOB_20240523065727_1u1FnnB6vyD5MI6adfUa8b",
  "filter": "history",
  "result_limit": 20,
  "result_offset": 0
}

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": {
	"total_items_available": 21,
	"items_included": 2,
	"page_number": 1,
	"page_count": 11,
	"page_size": 2,
	"sales": [
	  {
		"sale_id": 9637,
		"sale_date": "2024-05-02T10:35:38.1000000",
		"number_of_diamonds": 1,
		"total_carat_weight": 3.53,
		"total_diamond_price": 580,
		"status_id": 10,
		"status": "Transaction Initiated",
		"row_number": 1
	  },
	  {
		"sale_id": 9635,
		"sale_date": "2024-05-02T07:06:40.4300000",
		"number_of_diamonds": 1,
		"total_carat_weight": 2.73,
		"total_diamond_price": 1241,
		"status_id": 10,
		"status": "Transaction Initiated",
		"row_number": 2
	  }
	]
  }
}
		


Test the API


Generate JSON Request



POST






© IDEX Online 2024   -   www.idexonline.com