Seller.getSellers

Retrieves the sellers based on the passed ids . If none can be found with the given id, it returns false for this data set.

Execution frequency

Action is performed in various cases, when seller information is needed:

  • order import;
  • order data export;
  • seller profile review;
  • etc.

Request

JSON example:

[
  {
      "api":1,
      "method":"auth",
      "params":{
         "username":"...",
         "password":"..."
      },
      "id":1
   },
   {
    "api": 1,
    "method": "Seller.getSellers",
    "params": {
      "sellerIds": ["1", "2", "3"]
    },
    "id": 1
  }
]

Request fields:

Field name

Type

Value

Description

undefined undefined

method

string

"Seller.getSellers"

Action name

undefined undefined

sellerIds

array

["1", "2", "3"]

Seller Ids

undefined undefined

Response

Returns an array with the id as key and the seller data as value array when seller could be found or false if no entry could be found under the passed id.

JSON example:

[  
   {  
      "api":1,
      "result":{  
         "2191":{
            "status":"active",
            "email":"[email protected]",
            "name":"Seller Name",
            "shop_name":"Shop Name",
            "company_name":"Company Name",
            "phone":"0995982225987",
            "address1":"Address 1",
            "address2":"",
            "city":"City",
            "postcode":"123456",
            "country":"DE",
            "bank_account_name":"Account Name",
            "bank_account_nr":"8978943218",
            "bank_account_bank":"ABC",
            "bank_account_bank_code":"",
            "bank_account_iban":"",
            "bank_account_swift":"",
            "customercare_email":"[email protected]",
            "customercare_name":"Customercare Name",
            "customercare_phone":"7897123542225987",
            "customercare_address1":"Address 1",
            "customercare_address2":"",
            "customercare_city":"City",
            "customercare_postcode":"123456",
            "customercare_country":"DE",
            "terms_conditions":"Terms Conditions",
            "tagline":"tagline",
            "description":"Description"
         }
      },
      "id":1
   }
]

Field requirements and the formatting rules are the same as during the seller creationSeller.createSellers API.