{"_id":"5ab0f584ade4f4003cf6afcd","category":{"_id":"5ab0f55fade4f4003cf6af41","version":"5ab0f559ade4f4003cf6af38","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-23T19:23:42.327Z","from_sync":false,"order":8,"slug":"marketplace","title":"Marketplace"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"5ab0f559ade4f4003cf6af38","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-03-20T11:49:45.000Z","releaseDate":"2018-03-20T11:49:45.000Z","categories":["5ab0f55fade4f4003cf6af39","5ab0f55fade4f4003cf6af3a","5ab0f55fade4f4003cf6af3b","5ab0f55fade4f4003cf6af3c","5ab0f55fade4f4003cf6af3d","5ab0f55fade4f4003cf6af3e","5ab0f55fade4f4003cf6af3f","5ab0f55fade4f4003cf6af40","5ab0f55fade4f4003cf6af41","5ab0f55fade4f4003cf6af42","5ab0f55fade4f4003cf6af43","5ab0f55fade4f4003cf6af44","5ab0f55fade4f4003cf6af45","5ab0f55fade4f4003cf6af46","5ab0f55fade4f4003cf6af47"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-23T19:25:37.026Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"auth":"optional","params":[],"url":""},"isReference":false,"order":4,"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.\",\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 '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\\\": 47, \\n    \\\"lastPage\\\": false,\\n    \\\"vendor\\\": [\\n        {\\n            \\\"vendorId\\\": 514151,\\n            \\\"email\\\": \\\"vendor&#x40;bluesnap.com\\\",\\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            \\\"defaultPayoutCurrency\\\": \\\"USD\\\",\\n            \\\"frequency\\\": \\\"DAILY\\\",\\n            \\\"delay\\\": 3,\\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              \\t\\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n                \\\"email\\\": \\\"principal.name&#x40;vendor.com\\\"\\n            },\\n            \\\"payoutInfo\\\": [\\n                {\\n                    \\\"payoutType\\\": \\\"ACH\\\",\\n                    \\\"baseCurrency\\\": \\\"USD\\\",\\n                    \\\"nameOnAccount\\\": \\\"vendor\\\",\\n                    \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n                    \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n                    \\\"bankName\\\": \\\"Leumi\\\",\\n                    \\\"bankId\\\": \\\"12445\\\",\\n                    \\\"country\\\": \\\"us\\\",\\n                    \\\"city\\\": \\\"Juneau\\\",\\n                    \\\"address\\\": \\\"1 bank address\\\",\\n                    \\\"state\\\": \\\"MA\\\",\\n                    \\\"zip\\\": \\\"12345\\\",\\n                    \\\"bankAccountId\\\": \\\"36628822\\\",\\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            \\\"vendorId\\\": 514147,\\n            \\\"email\\\": \\\"vendor&#x40;bluesnap.com\\\",\\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            \\\"defaultPayoutCurrency\\\": \\\"USD\\\",\\n            \\\"frequency\\\": \\\"DAILY\\\",\\n            \\\"delay\\\": 3,\\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              \\t\\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n                \\\"email\\\": \\\"principal.name&#x40;vendor.com\\\"\\n            },\\n            \\\"payoutInfo\\\": [\\n                {\\n                    \\\"payoutType\\\": \\\"ACH\\\",\\n                    \\\"baseCurrency\\\": \\\"USD\\\",\\n                    \\\"nameOnAccount\\\": \\\"vendor\\\",\\n                    \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n                    \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n                    \\\"bankName\\\": \\\"Leumi\\\",\\n                    \\\"bankId\\\": \\\"12445\\\",\\n                    \\\"country\\\": \\\"us\\\",\\n                    \\\"city\\\": \\\"Juneau\\\",\\n                    \\\"address\\\": \\\"1 bank address\\\",\\n                    \\\"state\\\": \\\"MA\\\",\\n                    \\\"zip\\\": \\\"12345\\\",\\n                    \\\"bankAccountId\\\": \\\"36628822\\\",\\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>","excerpt":"","slug":"retrieve-all-vendors","type":"get","title":"Retrieve All Vendors"}

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.

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 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

{
    "totalResults": 47, 
    "lastPage": false,
    "vendor": [
        {
            "vendorId": 514151,
            "email": "vendor&#x40;bluesnap.com",
            "name": "Important Vendor",
            "firstName": "Joe",
            "lastName": "Smith",
            "address": "123 Main Street",
            "city": "Juneau",
            "zip": "4640802",
            "country": "us",
            "phone": "0549766778",
            "state": "MA",
            "defaultPayoutCurrency": "USD",
            "frequency": "DAILY",
            "delay": 3,
            "vendorPrincipal": {
                "firstName": "Joe",
                "lastName": "Smith",
                "address": "123 Main Street",
                "city": "Juneau",
                "zip": "12345",
                "country": "US",
                "dob": "28-09-9999",
                "personalIdentificationNumber": 1234,
              	"driverLicenseNumber": "561196411",
                "email": "principal.name&#x40;vendor.com"
            },
            "payoutInfo": [
                {
                    "payoutType": "ACH",
                    "baseCurrency": "USD",
                    "nameOnAccount": "vendor",
                    "bankAccountClass": "PERSONAL",
                    "bankAccountType": "CHECKING",
                    "bankName": "Leumi",
                    "bankId": "12445",
                    "country": "us",
                    "city": "Juneau",
                    "address": "1 bank address",
                    "state": "MA",
                    "zip": "12345",
                    "bankAccountId": "36628822",
                    "intermediaryBankInfo": {}
                }
            ],
            "vendorAgreement": {
                "commissionPercent": 30,
                "accountStatus": "ACTIVE",
                "recurringCommission": "Y"
            }, 
          "verification": {
            "payoutStatus": "Approved",
            "processingStatus": "Active",
          }
        },
        {
            "vendorId": 514147,
            "email": "vendor&#x40;bluesnap.com",
            "name": "Important Vendor",
            "firstName": "Joe",
            "lastName": "Smith",
            "address": "123 Main Street",
            "city": "Juneau",
            "zip": "4640802",
            "country": "us",
            "phone": "0549766778",
            "state": "MA",
            "defaultPayoutCurrency": "USD",
            "frequency": "DAILY",
            "delay": 3,
            "vendorPrincipal": {
                "firstName": "Joe",
                "lastName": "Smith",
                "address": "123 Main Street",
                "city": "Juneau",
                "zip": "12345",
                "country": "US",
                "dob": "28-09-9999",
                "personalIdentificationNumber": 1234,
              	"driverLicenseNumber": "561196411",
                "email": "principal.name&#x40;vendor.com"
            },
            "payoutInfo": [
                {
                    "payoutType": "ACH",
                    "baseCurrency": "USD",
                    "nameOnAccount": "vendor",
                    "bankAccountClass": "PERSONAL",
                    "bankAccountType": "CHECKING",
                    "bankName": "Leumi",
                    "bankId": "12445",
                    "country": "us",
                    "city": "Juneau",
                    "address": "1 bank address",
                    "state": "MA",
                    "zip": "12345",
                    "bankAccountId": "36628822",
                    "intermediaryBankInfo": {}
                }
            ],
            "vendorAgreement": {
                "commissionPercent": 30,
                "accountStatus": "ACTIVE",
                "recurringCommission": "Y"
            }, 
           "verification": {
              "payoutStatus": "Approved",
              "processingStatus": "Active",
          }          
        }
      ]
}