Skip to content
Guides
/
/
Update Suppliers
Last updated

Update Suppliers

Update existing supplier information including contact details, email addresses, and physical addresses. Keeping supplier information current ensures accurate purchase order delivery and communication.

Update a Supplier

Use the PUT method with /v2/suppliers/{supplier_id} to update an existing supplier's information.

Path Parameters

ParameterTypeDescription
supplier_idstringThe unique identifier of the supplier to update

Request Body Properties

The request body accepts the same properties as the create operation. supplier_name is required; all other fields are optional.

PropertyTypeRequiredDescription
supplier_namestringRequiredName of the supplier company
supplier_emailstring (email)OptionalEmail address for sending purchase orders
address_line_1stringOptionalFirst line of address
address_line_2stringOptionalSecond line of address
citystringOptionalCity
statestringOptionalState or province code
postal_codestringOptionalPostal or ZIP code
country_codestringOptionalISO 3166-1 alpha-2 country code
contact_namestringOptionalPrimary contact person's name
contact_phonestringOptionalContact phone number

Response

On success, returns a confirmation message:

{
  "message": "Supplier updated successfully"
}

Example Request & Response

PUT /v2/suppliers/{supplier_id}

curl -i -X PUT \
  https://api.shipstation.com/v2/suppliers/se-567 \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "supplier_name": "Acme Widgets Inc",
    "supplier_email": "orders@acmewidgets.com",
    "address_line_1": "123 Main St",
    "address_line_2": "Suite 100",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701",
    "country_code": "US",
    "contact_name": "John Doe",
    "contact_phone": "512-555-0100"
  }'

Validation Rules

Required Fields

  • supplier_name must be provided and cannot be empty

Email Validation

  • supplier_email must be a valid email format if provided
  • Format: name@domain.com

Country Codes

  • country_code must be a valid ISO 3166-1 alpha-2 code
  • Examples: "US", "CA", "GB", "DE", "FR", "AU"

Phone Numbers

  • No strict format required - use your preferred format
  • Include country code for international numbers (+44, +1, etc.)
  • Include extensions if needed (555-0100 ext 123)

Error Handling

Common errors when updating suppliers:

400 Bad Request

  • Missing supplier_name
  • Email format validation failure
  • Invalid country code

404 Not Found

  • Supplier ID not found
Previous page
Next page