Merchants

Prerequisites

You should have

• an user-account enabled for api access & Marketplace access
• an api-client

 

Merchant fields definitions

You can get dynamically all defined merchant fields with a simple api call.

 

Request URL

https://{your hublify url}/api/eos_10/data_getModel

Request parameter

{
    "dataset": "merchant"
}

Response

{
    "status": true,
    "data": {
        "baseModel": "merchant",
        "primary": "mrch_id",
        "primaryDisplay": "mrch_code",
        "fields": {
           ...
        }
    }
}

 

Getting merchants

Simply provide the fields you want to have returned..
 

Request URL

https://{your hublify url}/api/eos_10/data_getList

Request parameter

{
    "dataset": "merchant",
    "fields": [
        "mrch_id", 
        "mrch_code",
        "mrch_code_external",
        "mrch_name",
        "mrch_description",
        "mrch_company",
        "mrch_address2",
        "mrch_street",
        "mrch_housenr",
        "mrch_zip",
        "mrch_town",
        "mrch_country",
        "mrch_homepage",
        "mrch_support_email",
        "mrch_support_phone",
        "mrch_support_fax",
        "mrch_contacts"
    ]
}

Response

{
    "data": [
        {
            "mrch_id": "2",
            "mrch_code": "MRCH00002",
            "mrch_code_external": null,
            "mrch_name": "Max Merchant",
            "mrch_description": "Marktplatzbetreiber",

            // merchant imprint data
            // these address and contact details are meant for the public / customer
            // they are not used for internal invoicing etc.
 
            "mrch_company": "Merchant Ltd",               // company name 
            "mrch_address2": null,                        // postal address for imprint-pages etc. 
            "mrch_street": "Merchant Street",
            "mrch_housenr": "20c",
            "mrch_zip": "20459",
            "mrch_town": "Hamburg",
            "mrch_country": "DE",

            "mrch_homepage": "https:\/\/hublify.io",      
            "mrch_support_email": "support@hublify.io",   // support email
            "mrch_support_phone": "0123456789",           // support phone number
            "mrch_support_fax": null,

            // list of contacts (0-n)
            // for each contact you can specify the type of contact and provide names, department, email & phone-number and optional additonal details

            "mrch_contacts": {                            
                "data": [
                    {
                        "firstname": "Maja",
                        "lastname": "Market",
                        "type": "contact",
                        "department": "Marketing",
                        "email": "maja.market@example.com",
                        "phone": "0123456789",
                        "comment": "Extra infos about Maja"
                    },
                    {
                        "firstname": "Sam",
                        "lastname": "Sells",
                        "type": "contact",
                        "department": "Sales",
                        "email": "sam.sells@example.com",
                        "phone": "0123456789",
                        "comment": "Extra Infos about Sam"
                    }
                ]
            },

            // details about merchant specific costs, terms & conditions
            // for the various legal details country-specific overrides are available
            // costs and delivery details have to be provided for each country

            "mrch_conditions": {                                           
                "revocation_url": "https:\/\/widerruf.example.com",
                "terms_url": "https:\/\/agb.example.com",
                "privacy_url": "https:\/\/privacy.example.com",
                "return_conditions_url": "https:\/\/retoure.example.com",
                "return_conditions_description": "ein Text",
                "return_conditions_shipping_reimbursement": 0,
                "delivery_countries": [
                    "DE",
                    "AT",
                    "NL"
                ],
                "trackinginfo_customer": 1,
                "country_settings": {
                    "data": [
                        {
                            "delivery_country": "DE",
                            "xcost": "3.00",
                            "free_shipping_from": "100",
                            "delivery_time": "2 Tage",
                            "revocation_url": "",
                            "terms_url": "",
                            "privacy_url": "",
                            "return_conditions_url": "",
                            "return_conditions_description": "",
                            "return_conditions_shipping_reimbursement": 1
                        },
                        {
                            "delivery_country": "NL",
                            "xcost": "5.00",
                            "free_shipping_from": "150",
                            "delivery_time": "3 days",
                            "revocation_url": "https:\/\/widerruf-nl.example.com",
                            "terms_url": "https:\/\/terms-nl.example.com",
                            "privacy_url": "",
                            "return_conditions_url": "",
                            "return_conditions_description": "",
                            "return_conditions_shipping_reimbursement": ""
                        }
                    ]
                }
            }
        },
        {
            "mrch_id": "3",
            "mrch_code": "MRCH00003",
            "mrch_code_external": "YourMrchCode03",
            "mrch_name": "Markus Marktplatz",
            ...
        },
        ...
    ],
    "status": true,
    "meta": {
        "primaryKey": "mrch_id",
        "displayKey": "mrch_code"
    }
}