GET Agents by id

Overview

Retrieve Agent details by Id

Request

GET /Agents/[id]

Request Information

Request Parameters

Name
Type
Requirement
Description
id
String
Mandatory 
Code of the Agent

Response Information

Response Properties

Name
Type
Description
name
String
Name of Agent
code
String
Agent Code
email
String
Email of Agent
addressLine1
String
Address Line 1 of agent
addressLine2
String
Address Line 2 of agent
city
String
City of agent
state
String
State of agent
postcode
String
Postcode of agent
countryName
String
Country of agent (Only used in GET request)
countryCode
String
Country Code of agent
salesRegionCode
String
Sales Region Code of agent
isWholesaleAgent
Boolean
Flag provides information on whether agent is whole sale agent or not
isOnStatement
Boolean
This is discontinued please use isOnStatement flag in contract level
supportedCurrencies
List<Currency>
List of supported currencies for agent
contracts
List<Contract>
List of effective contracts for agent
paymentMethods
List<PaymentMethod>
List of available payment methods
isGroupAgent
Boolean
Is group agent
isStoreAgent
Boolean
Is store agent
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Supportedcurrencies

Name
Type
Description
code
String
Currency Code
name
String
Currency Name
isDefault
Boolean
Is default currency

Contracts

Name
Type
Description
sellingAgentId
Integer
Web default selling agent id
currencyCode
String
Currency Code
isOnStatement
Boolean
Flag provides information on whether agent is on statement or not

Paymentmethods

Name
Type
Description
id
Integer
payment method identifier
name
String
payment method name
currencyCode
String
currency code
sellingAgentId
Integer
selling agent identifier
paymentCards
List<PaymentCard>
List of allowed payment cards
onlineFlag
Boolean
payment method is for online payments

Paymentcards

Name
Type
Description
id
Integer
payment method identifier
name
String
payment card name
uniquePaymentMethodCode
String
unique payment method code

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

{
  "name": "Test Agent",
  "code": "12345678",
  "email": "test@test.com",
  "addressLine1": "2 Dreamworks Street",
  "addressLine2": "Dreamworks",
  "city": "Sherwood",
  "state": "Vic",
  "postcode": "3999",
  "countryName": "Australia",
  "countryCode": "AU",
  "salesRegionCode": "AU",
  "isWholesaleAgent": true,
  "isOnStatement": false,
  "supportedCurrencies": [
    {
      "code": "GBP",
      "name": "Great British Pound",
      "isDefault": "True"
    },
    {
      "code": "GBP",
      "name": "Great British Pound",
      "isDefault": "True"
    }
  ],
  "contracts": [
    {
      "sellingAgentId": "12345",
      "currencyCode": "GBP",
      "isOnStatement": true
    },
    {
      "sellingAgentId": "12345",
      "currencyCode": "GBP",
      "isOnStatement": true
    }
  ],
  "paymentMethods": [
    {
      "id": "21",
      "name": "Payment Gate",
      "currencyCode": "AUD",
      "sellingAgentId": 12345,
      "paymentCards": [
        {
          "id": "21",
          "name": "Visa",
          "uniquePaymentMethodCode": "scheme"
        },
        {
          "id": "21",
          "name": "Visa",
          "uniquePaymentMethodCode": "scheme"
        }
      ],
      "onlineFlag": null
    },
    {
      "id": "21",
      "name": "Payment Gate",
      "currencyCode": "AUD",
      "sellingAgentId": 12345,
      "paymentCards": [
        {
          "id": "21",
          "name": "Visa",
          "uniquePaymentMethodCode": "scheme"
        },
        {
          "id": "21",
          "name": "Visa",
          "uniquePaymentMethodCode": "scheme"
        }
      ],
      "onlineFlag": null
    }
  ],
  "isGroupAgent": true,
  "isStoreAgent": true,
  "id": 887124,
  "href": "agents/887124",
  "sequence": "202403312359580000"
}