Retrieve vendorBeta

GET

/v2/vendors/{vendor_id}

Retrieves the vendor of a specified Vendor ID.

Permissions:VENDOR_READ

Guide

Retrieve vendors

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

vendor_id

string

Required

ID of the Vendor to retrieve.

Link to section

Response fields

Link to section

errors

Errors encountered when the request fails.

Link to section

vendor

The successfully retrieved Vendor object.

Link to section

Examples

GET /v2/vendors/{vendor_id}

curl https://connect.squareup.com/v2/vendors/INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4 \
  -H 'Square-Version: 2024-11-20' \
  -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": "[email protected]",
        "phone_number": "1-212-555-4250"
      }
    ],
    "account_number": "4025391",
    "note": "a vendor",
    "version": 1,
    "status": "ACTIVE"
  },
  "errors": []
}