lookupProducts

This operation is used to retrieve a list of products, filtered using the query parameter(s).This operation has no financial impact and is informative only.

SecurityhttpBasic

Request

query Parameters

channelName	string The name of the channel to retrieve products for. If set only products matching this channel name will be returned. If not set, all products will be returned.
receiverId	string The unique Id of the receiving entity from which to retrieve the list of products.

Responses

200

400

Bad request

404

Not found

500

Internal server error

503

Service unavailable

504

Gateway timeout

get/products

Request samples

curl
Java
Node.js

Response samples

application/json

{"products": [{"productId": "string",
"barcode": "string",
"name": "string",
"amount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"minAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"maxAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"description": "string",
"isFixedValue": false,
"receiver": {"id": "string",
"name": "string"
},
"channelProductListings": [{"channelName": "string",
"productDisplayName": "string",
"productDisplayCategory": "string",
"productDisplaySortOrder": 0,
"channelProductIdentifier": "string"
}
]
}
]
}