{"_id":"5a7b5391724509001c038443","category":{"_id":"5a7b538e724509001c0383f4","version":"5a7b538e724509001c0383eb","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":"5a7b538e724509001c0383eb","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-02-07T19:29:18.655Z","releaseDate":"2018-02-07T19:29:18.655Z","categories":["5a7b538e724509001c0383ec","5a7b538e724509001c0383ed","5a7b538e724509001c0383ee","5a7b538e724509001c0383ef","5a7b538e724509001c0383f0","5a7b538e724509001c0383f1","5a7b538e724509001c0383f2","5a7b538e724509001c0383f3","5a7b538e724509001c0383f4","5a7b538e724509001c0383f5","5a7b538e724509001c0383f6","5a7b538e724509001c0383f7","5a7b538e724509001c0383f8","5a7b538e724509001c0383f9","5a7b538e724509001c0383fa"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.24.1 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":[{"_id":"5a1c1e96137ca9001238dd35","ref":"","in":"query","required":false,"desc":"Vendor ID. The response will get the page of results after the specified ID (exclusive).","default":"","type":"int","name":"after"},{"_id":"5a1c1e96137ca9001238dd34","ref":"","in":"query","required":false,"desc":"Vendor ID. The response will get the page of results before the specified ID (exclusive).","default":"","type":"int","name":"before"},{"_id":"5a1c1e96137ca9001238dd33","ref":"","in":"query","required":false,"desc":"Indicates whether the number of total results appears in the response.","default":"false","type":"boolean","name":"gettotal"},{"_id":"5a1c1e96137ca9001238dd32","ref":"","in":"query","required":false,"desc":"Sets the maximum number of results to return (i.e. page size).","default":"10","type":"int","name":"pagesize"}],"url":"/vendors"},"isReference":false,"order":4,"body":"[block:html]\n{\n  \"html\": \"<script>\\n  // hide body textbox of API Explorer\\n $(document).ready(function() {\\n  $(\\\"textarea[placeholder='Body Content']\\\").hide();  \\n }); \\n</script>\"\n}\n[/block]\nThe Retrieve All Vendors request retrieves all your vendors and their saved details.\n\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nNo content is required in the request body. See above for the supported query parameters\n\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<hr>\n\n##API Explorer\nTo test out a Retrieve All Vendors call, optionally enter any values for the query parameters, and click the **Try it!** button below.","excerpt":"","slug":"retrieve-all-vendors","type":"get","title":"Retrieve All Vendors"}

getRetrieve All Vendors


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

after:
integer
Vendor ID. The response will get the page of results after the specified ID (exclusive).
before:
integer
Vendor ID. The response will get the page of results before the specified ID (exclusive).
gettotal:
booleanfalse
Indicates whether the number of total results appears in the response.
pagesize:
integer10
Sets the maximum number of results to return (i.e. page size).

Documentation

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

Try it in the API Explorer

Request Content

No content is required in the request body. See above for the supported query parameters

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",
          }          
        }
      ]
}


API Explorer

To test out a Retrieve All Vendors call, optionally enter any values for the query parameters, and click the Try it! button below.


User Information

Try It Out


get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}