Update a customer

Request

Updates a customer's name, email, addresses and settings. name and email are required; everything else is optional and left unchanged when omitted.

Accepts user session headers only. Contact support to request API key access for this endpoint.

Security

UserGuid and UserToken and SupplierGuid

Path

vendorGuidstring, (uuid)required

GUID of the customer (vendor).

Bodyapplication/jsonrequired

namestringrequired

emailstringrequired

billToobject(AddressInput)

Address fields accepted when creating or updating an address.

shipToobject(AddressInput)

Address fields accepted when creating or updating an address.

optionsobject(VendorOptions)

Optional customer settings. All fields are optional; omitted fields are left unchanged.

tokenOptionsobject

Connection-level settings for the customer's login (catalog / price group locks, discounts).

shippingDetailsArray of objects

Replaces the customer's saved shipping preferences (carrier / service defaults).

shippingAccountsArray of objects

Replaces the customer's third-party shipping accounts.

curl -i -X PUT \
  'https://docs.orderwerks.com/_mock/openapi/v1/vendors/{vendorGuid}' \
  -H 'Content-Type: application/json' \
  -H 'supplierGuid: YOUR_API_KEY_HERE' \
  -H 'userGuid: YOUR_API_KEY_HERE' \
  -H 'userToken: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Acme, Inc.",
    "email": "orders@acme.example",
    "options": {
      "price_group_id": 12,
      "require_po": true
    }
  }'

Responses

The updated customer.

Bodyapplication/json

vendorModelobject(Vendor)

A customer of the supplier. The full model includes many integration-specific fields (QuickBooks, Stripe, FastBound, routing); only the commonly used ones are listed here.

resourcestring

Example:"vendor"

Response

{
  "vendorModel": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "supplier_id": 0,
    "parent_vendor_id": 0,
    "customer_internal_id": "string",
    "name": "string",
    "email": "string",
    "shipping_email": "string",
    "phone": "string",
    "cell": "string",
    "fax": "string",
    "address_line_one": "string",
    "address_line_two": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "string",
    "active": true,
    "tax_exempt": true,
    "resale_tax_id": "string",
    "lock_catalog_id": 0,
    "price_group_id": 0,
    "payment_type_id": 0,
    "payment_term_id": 0,
    "require_payment": true,
    "credit_limit": 0,
    "open_balance": 0,
    "is_ecomm_user": true,
    "net_term_ecomm_user": true,
    "require_po": true,
    "standing_po": "string",
    "hide_pricing": true,
    "currency_id": 0,
    "notes": "string",
    "default_order_category_id": 0,
    "route_id": 0,
    "timezone": "string",
    "bill_to_id": 0,
    "ship_to_id": 0,
    "Bill_To": {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "vendor_id": 0,
      "order_id": 0,
      "name": "string",
      "company_name": "string",
      "address_line_one": "string",
      "address_line_two": "string",
      "address_line_three": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "string",
      "phone": "string",
      "fax": "string",
      "email": "string",
      "note": "string",
      "address_internal_id": "string",
      "is_vendor_main_ship_to": true,
      "verified": true,
      "lat": 0,
      "lng": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "Ship_To": {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "vendor_id": 0,
      "order_id": 0,
      "name": "string",
      "company_name": "string",
      "address_line_one": "string",
      "address_line_two": "string",
      "address_line_three": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "string",
      "phone": "string",
      "fax": "string",
      "email": "string",
      "note": "string",
      "address_internal_id": "string",
      "is_vendor_main_ship_to": true,
      "verified": true,
      "lat": 0,
      "lng": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z"
  },
  "resource": "vendor"
}