Lookup

POST 
/lookup

Performs a request for data lookup for use in api session. Bearer authentication required. The request body requires module; for example, { "module": "country" }.

Available lookup modules: currency, country, productcatalogue, and provider.

Request

application/json

Body

request payload

module stringrequired

Lookup module to return. Available values: currency, country, productcatalogue, provider.

Responses

201

request successful

application/json

Schema

Schema

success booleanrequired
code int32required
message string

data

object

Lookup response data.

rc integerrequired

Number of records returned.

sd [

rid integerrequired

record id. dropdown value

nam stringrequired

name. dropdown label

shc string

short code.

]

trackid uuid
stamp int32

Example (from schema)

{
  "success": true,
  "code": 0,
  "message": "OK",
  "stamp": "2026-09-07T09:08:26+00:00",
  "trackid": "<uuid>",
  "data": {
    "rc": 5,
    "sd": [
      {
        "nam": "Cote D'Ivoire",
        "rid": 4
      },
      {
        "nam": "Default",
        "rid": 0
      },
      {
        "nam": "Ghana",
        "rid": 1
      },
      {
        "nam": "Nigeria",
        "rid": 3
      },
      {
        "nam": "United States",
        "rid": 5
      }
    ]
  }
}

400

invalid input, object invalid

401

Access token is missing or invalid

409

request failed

Loading...