Skip to main content
PUT
/
v2
/
vendors
/
{vendorId}
/
address
Update Vendor Address
curl --request PUT \
  --url https://api.puppetvendors.com/v2/vendors/{vendorId}/address \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "country": "<string>",
  "zip": "<string>",
  "phone": "<string>"
}
'
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Update the address for a specific vendor. All fields are optional; only provided fields will be updated. The address is used for shipping origin calculations, payout documentation, and vendor correspondence.

​
Use Cases

  • Vendor onboarding — Set the vendor’s address during initial setup
  • Address changes — Update address when a vendor relocates
  • Integration sync — Push address updates from external systems

​
Path Parameters

​
vendorId
string
required
The vendor’s MongoDB ObjectId.

​
Request Body

​
address1
string
Primary address line (max 500 characters).
​
address2
string
Secondary address line (max 500 characters).
​
city
string
City name (max 200 characters).
​
state
string
State or province (max 200 characters).
​
country
string
Country name (max 200 characters).
​
zip
string
Postal or ZIP code (max 50 characters).
​
phone
string
Phone number (max 50 characters).

​
Response

200
{
  "success": true,
  "data": {
    "address": {
      "address1": "456 New Road",
      "address2": "Floor 2",
      "city": "Manchester",
      "state": "England",
      "country": "United Kingdom",
      "zip": "M1 1AA",
      "phone": "+44 161 234 5678"
    }
  }
}

​
Error Responses

400
{
  "success": false,
  "error": {
    "message": "address1 must not exceed 500 characters",
    "code": "VALIDATION_ERROR"
  }
}
404
{
  "success": false,
  "error": {
    "message": "Vendor not found",
    "code": "NOT_FOUND"
  }
}

​
Example

curl -X PUT https://api.puppetvendors.com/v2/vendors/507f1f77bcf86cd799439011/address \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_JWT_TOKEN" \
  -d '{
    "address1": "456 New Road",
    "address2": "Floor 2",
    "city": "Manchester",
    "state": "England",
    "country": "United Kingdom",
    "zip": "M1 1AA",
    "phone": "+44 161 234 5678"
  }'