Skip to main content
PUT
/
v1
/
vendors
/
{vendorId}
/
address
Update Vendor Address
curl --request PUT \
  --url https://api.puppetvendors.com/v1/vendors/{vendorId}/address \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postalCode": "<string>",
  "country": "<string>"
}
'

Overview

Sets or updates the vendor’s business address. Only recognized address fields are accepted; unknown keys are ignored.

Use Cases

  • Onboard vendors by collecting their address through an external form
  • Keep addresses in sync with an external vendor management system
  • Update return addresses for fulfillment workflows

Path Parameters

vendorId
string
required
The vendor’s unique ID.

Request Body

address1
string
Primary address line.
address2
string
Secondary address line (suite, unit, etc.).
city
string
City name.
state
string
State or province.
postalCode
string
Postal or ZIP code.
country
string
Country name.

Response

200
{
  "message": "Vendor address updated successfully.",
  "vendor": { ... }
}

Example

curl -X PUT "https://api.puppetvendors.com/v1/vendors/6157faecbebcf01bf49097d9/address" \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_JWT_TOKEN" \
  -d '{
    "address1": "123 Market Street",
    "city": "London",
    "postalCode": "EC1A 1BB",
    "country": "United Kingdom"
  }'