{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"optional","method":"get","results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Retrieve All Vendors","type":"endpoint","slug":"retrieve-all-vendors","excerpt":"","body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/vendors?{parameters}</span>\n\n##Documentation\nThe Retrieve All Vendors request retrieves all your vendors and their saved details.\n\n\n###Request Content\nEnter any of the query parameters below into the request URL. For example:\n`services/2/vendors?pagesize=20&after=34567&gettotal=true`\n\n**Query Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example\",\n    \"0-0\": \"`after`\",\n    \"0-1\": \"Vendor ID. The response will get the page of results after the specified ID (exclusive).\",\n    \"0-2\": \"`after=34567`\",\n    \"1-0\": \"`before`\",\n    \"1-1\": \"Vendor ID. The response will get the page of results before the specified ID (exclusive).\",\n    \"1-2\": \"`before=12345`\",\n    \"2-0\": \"`gettotal`\",\n    \"2-1\": \"**true** = Include the number of total results in the response\",\n    \"2-2\": \"`gettotal=true`\",\n    \"3-0\": \"`pagesize`\",\n    \"3-1\": \"Positive integer. Sets the maximum number of results to return (i.e. page size).\\nDefault is **10** if not set.\\nMaximum is **500**.\",\n    \"3-2\": \"`pagesize=20`\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the [vendors](doc:vendors) object.\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/vendors?gettotal=true\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve All Vendors Request\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"totalResults\\\": 746,\\n  \\\"lastPage\\\": false,\\n  \\\"vendor\\\": [\\n    {\\n      \\\"vendorId\\\": 10415692,\\n      \\\"email\\\": \\\"vendor:::at:::bluesnap.com\\\",\\n      \\\"name\\\": \\\"Important Vendor\\\",\\n      \\\"vendorUrl\\\": \\\"http://mycompany.com\\\",\\n      \\\"firstName\\\": \\\"Joe\\\",\\n      \\\"lastName\\\": \\\"Smith\\\",\\n      \\\"address\\\": \\\"123 Main Street\\\",\\n      \\\"city\\\": \\\"testing city\\\",\\n      \\\"zip\\\": \\\"4640802\\\",\\n      \\\"country\\\": \\\"us\\\",\\n      \\\"phone\\\": \\\"1-054-976-6778\\\",\\n      \\\"state\\\": \\\"MA\\\",\\n      \\\"defaultPayoutCurrency\\\": \\\"USD\\\",\\n      \\\"frequency\\\": \\\"MONTHLY\\\",\\n      \\\"delay\\\": 14,\\n      \\\"vendorPrincipal\\\": {\\n        \\\"firstName\\\": \\\"Joe\\\",\\n        \\\"lastName\\\": \\\"Smith\\\",\\n        \\\"address\\\": \\\"123 Main Street\\\",\\n        \\\"city\\\": \\\"Juneau\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"dob\\\": \\\"28-09-9999\\\",\\n        \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n        \\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n        \\\"email\\\": \\\"[email protected]\\\"\\n      },\\n      \\\"payoutInfo\\\": [\\n        {\\n          \\\"payoutType\\\": \\\"WIRE\\\",\\n          \\\"baseCurrency\\\": \\\"USD\\\",\\n          \\\"nameOnAccount\\\": \\\"vendor\\\",\\n          \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n          \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n          \\\"bankName\\\": \\\"Leumi\\\",\\n          \\\"bankId\\\": \\\"12445\\\",\\n          \\\"country\\\": \\\"us\\\",\\n          \\\"city\\\": \\\"Portland\\\",\\n          \\\"address\\\": \\\"1 bank address\\\",\\n          \\\"state\\\": \\\"MA\\\",\\n          \\\"zip\\\": \\\"12345\\\",\\n          \\\"bankAccountId\\\": \\\"36628822\\\",\\n          \\\"intermediaryBankInfo\\\": {}\\n        }\\n      ],\\n      \\\"vendorAgreement\\\": {\\n        \\\"commissionPercent\\\": 20,\\n        \\\"accountStatus\\\": \\\"ACTIVE\\\",\\n        \\\"recurringCommission\\\": \\\"Y\\\"\\n      },\\n      \\\"verification\\\": {\\n        \\\"payoutStatus\\\": \\\"Approved\\\",\\n        \\\"processingStatus\\\": \\\"Active\\\"\\n      }\\n    },\\n    {\\n      \\\"vendorId\\\": 10409208,\\n      \\\"email\\\": \\\"[email protected]\\\",\\n      \\\"name\\\": \\\"Important Vendor\\\",\\n      \\\"firstName\\\": \\\"Joe\\\",\\n      \\\"lastName\\\": \\\"Smith\\\",\\n      \\\"address\\\": \\\"123 Main Street\\\",\\n      \\\"city\\\": \\\"Juneau\\\",\\n      \\\"zip\\\": \\\"4640802\\\",\\n      \\\"country\\\": \\\"us\\\",\\n      \\\"phone\\\": \\\"0549766778\\\",\\n      \\\"state\\\": \\\"MA\\\",\\n      \\\"taxId\\\": \\\"123456789\\\",\\n      \\\"defaultPayoutCurrency\\\": \\\"USD\\\",\\n      \\\"frequency\\\": \\\"MONTHLY\\\",\\n      \\\"delay\\\": 14,\\n      \\\"vendorPrincipal\\\": {\\n        \\\"firstName\\\": \\\"Joe\\\",\\n        \\\"lastName\\\": \\\"Smith\\\",\\n        \\\"address\\\": \\\"123 Main Street\\\",\\n        \\\"city\\\": \\\"Juneau\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"dob\\\": \\\"28-09-9999\\\",\\n        \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n        \\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n        \\\"email\\\": \\\"[email protected]\\\"\\n      },\\n      \\\"payoutInfo\\\": [\\n        {\\n          \\\"payoutType\\\": \\\"ACH\\\",\\n          \\\"baseCurrency\\\": \\\"USD\\\",\\n          \\\"minimalPayoutAmount\\\": \\\"50\\\",\\n          \\\"nameOnAccount\\\": \\\"vendor\\\",\\n          \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n          \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n          \\\"bankName\\\": \\\"Leumi\\\",\\n          \\\"bankId\\\": \\\"124456789\\\",\\n          \\\"country\\\": \\\"us\\\",\\n          \\\"city\\\": \\\"Juneau\\\",\\n          \\\"address\\\": \\\"1 bank address\\\",\\n          \\\"state\\\": \\\"MA\\\",\\n          \\\"zip\\\": \\\"12345\\\",\\n          \\\"bankAccountId\\\": \\\"366288322\\\",\\n          \\\"intermediaryBankInfo\\\": {}\\n        }\\n      ],\\n      \\\"vendorAgreement\\\": {\\n        \\\"commissionPercent\\\": 30,\\n        \\\"accountStatus\\\": \\\"ACTIVE\\\",\\n        \\\"recurringCommission\\\": \\\"Y\\\"\\n      },\\n      \\\"verification\\\": {\\n        \\\"payoutStatus\\\": \\\"Approved\\\",\\n        \\\"processingStatus\\\": \\\"Active\\\"\\n      }\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Retrieve All Vendors Response\"\n    }\n  ]\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f43d7db37d54d01d8ef0844","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Marketplace","slug":"marketplace","order":11,"from_sync":false,"reference":false,"_id":"5f43d7db37d54d01d8ef07d3","version":"5f43d7db37d54d01d8ef0876","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-11-23T19:23:42.327Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.35 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f43d7db37d54d01d8ef07cb","5f43d7db37d54d01d8ef07cc","5f43d7db37d54d01d8ef07cd","5f43d7db37d54d01d8ef07ce","5f43d7db37d54d01d8ef07cf","5f43d7db37d54d01d8ef07d0","5f43d7db37d54d01d8ef07d1","5f43d7db37d54d01d8ef07d2","5f43d7db37d54d01d8ef07d3","5f43d7db37d54d01d8ef07d4","5f43d7db37d54d01d8ef07d5","5f43d7db37d54d01d8ef07d6","5f43d7db37d54d01d8ef07d7","5f43d7db37d54d01d8ef07d8","5f43d7db37d54d01d8ef07d9","5f43d7db37d54d01d8ef07da","5f43d7db37d54d01d8ef07db","5f45521ec5bfe9005a858533"],"_id":"5f43d7db37d54d01d8ef0876","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5ed0377101fdb400214dedaa","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-11-23T19:25:37.026Z","githubsync":"","__v":0}

getRetrieve All Vendors


Definition

https://sandbox.bluesnap.com/services/2/vendors?{parameters}

Documentation

The Retrieve All Vendors request retrieves all your vendors and their saved details.

Request Content

Enter any of the query parameters below into the request URL. For example:
services/2/vendors?pagesize=20&after=34567&gettotal=true

Query Parameters

Parameter Name
Description
Example

after

Vendor ID. The response will get the page of results after the specified ID (exclusive).

after=34567

before

Vendor ID. The response will get the page of results before the specified ID (exclusive).

before=12345

gettotal

true = Include the number of total results in the response

gettotal=true

pagesize

Positive integer. Sets the maximum number of results to return (i.e. page size).
Default is 10 if not set.
Maximum is 500.

pagesize=20

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the vendors object.


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/vendors?gettotal=true
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

{
  "totalResults": 746,
  "lastPage": false,
  "vendor": [
    {
      "vendorId": 10415692,
      "email": "[email protected]",
      "name": "Important Vendor",
      "vendorUrl": "http://mycompany.com",
      "firstName": "Joe",
      "lastName": "Smith",
      "address": "123 Main Street",
      "city": "testing city",
      "zip": "4640802",
      "country": "us",
      "phone": "1-054-976-6778",
      "state": "MA",
      "defaultPayoutCurrency": "USD",
      "frequency": "MONTHLY",
      "delay": 14,
      "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Juneau",
        "zip": "12345",
        "country": "US",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
        "driverLicenseNumber": "561196411",
        "email": "[email protected]"
      },
      "payoutInfo": [
        {
          "payoutType": "WIRE",
          "baseCurrency": "USD",
          "nameOnAccount": "vendor",
          "bankAccountClass": "PERSONAL",
          "bankAccountType": "CHECKING",
          "bankName": "Leumi",
          "bankId": "12445",
          "country": "us",
          "city": "Portland",
          "address": "1 bank address",
          "state": "MA",
          "zip": "12345",
          "bankAccountId": "36628822",
          "intermediaryBankInfo": {}
        }
      ],
      "vendorAgreement": {
        "commissionPercent": 20,
        "accountStatus": "ACTIVE",
        "recurringCommission": "Y"
      },
      "verification": {
        "payoutStatus": "Approved",
        "processingStatus": "Active"
      }
    },
    {
      "vendorId": 10409208,
      "email": "[email protected]",
      "name": "Important Vendor",
      "firstName": "Joe",
      "lastName": "Smith",
      "address": "123 Main Street",
      "city": "Juneau",
      "zip": "4640802",
      "country": "us",
      "phone": "0549766778",
      "state": "MA",
      "taxId": "123456789",
      "defaultPayoutCurrency": "USD",
      "frequency": "MONTHLY",
      "delay": 14,
      "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Juneau",
        "zip": "12345",
        "country": "US",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
        "driverLicenseNumber": "561196411",
        "email": "[email protected]"
      },
      "payoutInfo": [
        {
          "payoutType": "ACH",
          "baseCurrency": "USD",
          "minimalPayoutAmount": "50",
          "nameOnAccount": "vendor",
          "bankAccountClass": "PERSONAL",
          "bankAccountType": "CHECKING",
          "bankName": "Leumi",
          "bankId": "124456789",
          "country": "us",
          "city": "Juneau",
          "address": "1 bank address",
          "state": "MA",
          "zip": "12345",
          "bankAccountId": "366288322",
          "intermediaryBankInfo": {}
        }
      ],
      "vendorAgreement": {
        "commissionPercent": 30,
        "accountStatus": "ACTIVE",
        "recurringCommission": "Y"
      },
      "verification": {
        "payoutStatus": "Approved",
        "processingStatus": "Active"
      }
    }
  ]
}