Bulk update vendorsBeta

PUT

/v2/vendors/bulk-update

Updates one or more of existing Vendor objects as suppliers to a seller.

Permissions:VENDOR_WRITE

Guide

Update vendors

Try in API Explorer

Link to section

Request body

Example code

Link to section

vendors

Required

A set of UpdateVendorRequest objects encapsulating to-be-updated Vendor objects. The set is represented by a collection of Vendor-ID/UpdateVendorRequest-object pairs.

Show attributes

Link to section

Response fields

Link to section

errors

Errors encountered when the request fails.

Show attributes

Link to section

responses

A set of UpdateVendorResponse objects encapsulating successfully created Vendor objects or error responses for failed attempts. The set is represented by a collection of Vendor-ID/UpdateVendorResponse-object or Vendor-ID/error-object pairs.

Show attributes

Link to section

Examples

PUT /v2/vendors/bulk-update

curl https://connect.squareup.com/v2/vendors/bulk-update \
  -X PUT \
  -H 'Square-Version: 2023-05-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "vendors": {
      "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": {
        "note": "favorite vendor",
        "version": 30,
        "status": "ACTIVE"
      },
      "FMCYHBWT1TPL8MFH52PBMEN92A": {
        "address": {
          "address_line_1": "202 Mill St",
          "locality": "Moorestown",
          "administrative_district_level_1": "NJ",
          "postal_code": "08057",
          "country": "US"
        },
        "version": 10,
        "status": "ACTIVE"
      }
    }
  }'

Response JSON

{
  "vendors": {
    "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": {
      "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4",
      "created_at": "2022-03-16T10:10:54.859Z",
      "updated_at": "2022-03-16T20: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",
          "ordinal": 0
        }
      ],
      "account_number": "4025391",
      "note": "favorite vendor",
      "version": 31,
      "status": "ACTIVE"
    },
    "INV_V_FMCYHBWT1TPL8MFH52PBMEN92A": {
      "id": "INV_V_FMCYHBWT1TPL8MFH52PBMEN92A",
      "created_at": "2022-03-16T10:21:54.859Z",
      "updated_at": "2022-03-16T20:21:54.859Z",
      "name": "Annie’s Hot Sauce",
      "contacts": [
        {
          "id": "INV_VC_ABYYHBWT1TPL8MFH52PBMENPJ4",
          "name": "Annie Thomas",
          "email_address": "[email protected]",
          "phone_number": "1-212-555-4250",
          "ordinal": 0
        }
      ],
      "address": {
        "address_line_1": "202 Mill St",
        "locality": "Moorestown",
        "administrative_district_level_1": "NJ",
        "postal_code": "08057",
        "country": "US"
      },
      "version": 11,
      "status": "ACTIVE"
    }
  }
}