Retrieve vendor BETA
GET
/v2/vendors/{vendor_id}
Retrieves the vendor of a specified Vendor ID.
Name | Description |
---|---|
vendor_
Required
|
ID of the Vendor to retrieve. |
Response Fields
Name | Description |
---|---|
errors
|
Errors encountered when the request fails. |
vendor
|
The successfully retrieved Vendor object. |
Examples
GET
/v2/vendors/{vendor_id}
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/vendors/INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 \
-H 'Square-Version: 2023-01-19' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Response JSON
{
"vendor": {
"id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4",
"created_at": "2022-03-16T10:21:54.859Z",
"updated_at": "2022-03-16T10:21:54.859Z",
"name": "Joe's Fresh Seafood",
"address": {
"address_line_1": "505 Electric Ave",
"address_line_2": "Suite 600",
"locality": "New York",
"administrative_district_level_1": "NY",
"postal_code": "10003",
"country": "US"
},
"contacts": [
{
"id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A",
"name": "Joe Burrow",
"email_address": "joe@joesfreshseafood.com",
"phone_number": "1-212-555-4250"
}
],
"account_number": "4025391",
"note": "a vendor",
"version": 1,
"status": "ACTIVE"
},
"errors": []
}