Understanding Marketplace data
With the help of the login details and the unique identifier of your Marketplace (uuid) transmitted by our services, you can access your Marketplace data by calling the resource:
GET /marketplaces/{uuid} Here is an example of a response for a Marketplace whose uuid is 2434c0a2-9d46-4e96-9553-1536c898625b:
Request
GET https://secure.lyra.com/marketplace/marketplaces/2434c0a2-9d46-4e96-9553-1536c898625b Response
{
"href":"https://secure.lyra.com/marketplace/marketplaces/2434c0a2-9d46-4e96-9553-1536c898625
"uuid":"2434c0a2-9d46-4e96-9553-1536c898625b",
"created_at":"2017-03-13T14:58:40.801000Z",
"updated_at":"2020-12-07T10:41:12.184969Z",
"reference":"MKP000001",
"description":"La maison du cheesecake",
"billing_method":"CASHOUT",
"bic":"",
"iban":"",
"vads_key":"12345678",
"vads_cert":"123456789012345",
"status":"ACTIVE",
"links": {
"sellers": {
"href":"https://secure.lyra.com/marketplace/marketplaces/2434c0a2-9d46-4e96-9553-1536c89
},
"orders": {
"href":"https://secure.lyra.com/marketplace/marketplaces/2434c0a2-9d46-4e96-9553-1536c898
},
"registrations":{
"href":"http://secure.lyra.com/marketplace/marketplaces/2434c0a2-9d46-4e96-9553-1536c8986
},
"webhooks":{
"href":"http://secure.lyra.com/marketplace/marketplaces/2434c0a2-9d46-4e96-9553-1536c8986
}
},
"max_capture_delay":6,
"tva_rate":"20.00",
"currencies":[
{
"currency":"EUR",
"commission_prorata":2.0,
"commission_fix":20,
"is_active":true
},
{
"currency":"GBP",
"commission_prorata":1.0,
"commission_fix":60,
"is_active":true
}
],
"vouchers": [
{
"contract_type":"CONECS"
}
]
} What do we know from this example?
- First of all, that the Marketplace is active. That it corresponds to the shop ID “12345678” with the key “123456789012345”.These two pieces of information are accessible via the Expert Back Office and are specified directly by the Lyra Collect services upon the Marketplace registration.
- Its billing_method indicates that it is configured for a so-called “cashout” direct debit. As opposed to a “monthly” direct debit, the marketplace must respect a minimum commission amount for each order.
- The list of available webhooks used by the marketplace can be found at the following address: "https://secure.lyra.com/marketplace/marketplaces/2434c0a2-9d46-4e96-9553-1536c898625b/webhooks"
- The list of sellers can be found at the following address:
"https://secure.lyra.com/marketplace/marketplaces/2434c0a2-9d46-4e96-9553-1536c898625b/sellers" - The list of orders can be found at the following address:
"http://secure.lyra.com/marketplace/marketplaces/2434c0a2-9d46-4e96-9553-1536c898625b/orders" - There are two currencies enabled on the Marketplace, with separate minimum commission parameters:
- Euro, with 2% of the pro rata of the total order amount and 10 cents per transaction;
- Pound sterling, with 1% of the total order amount and 60 pence.
- Finally, the marketplace can accept the registration of 'CONECS' acquirer MIDs for its sub-merchants, who can then offer payment by meal voucher.
