Skip to content
/
Get a customer

Get a customer

Request

Returns one customer (vendor) with its addresses, integration links and shipping preferences.

Security
(ApiKey and ApiSecret) or (UserGuid and UserToken and SupplierGuid)
Path
vendorGuidstring, (uuid)required

GUID of the customer (vendor).

curl -i -X GET \
  'https://docs.orderwerks.com/_mock/openapi/v1/vendors/{vendorGuid}' \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE'

Responses

The customer.

Bodyapplication/json
idinteger
guidstring, (uuid)
supplier_idinteger
parent_vendor_idinteger or null
customer_internal_idstring or null

Your own identifier for this customer.

namestring
emailstring
shipping_emailstring or null
phonestring or null
cellstring or null
faxstring or null
address_line_onestring or null
address_line_twostring or null
citystring or null
statestring or null
postal_codestring or null
countrystring or null
activeboolean
tax_exemptboolean
resale_tax_idstring or null
lock_catalog_idinteger or null

When set, the customer can only order from this catalog.

price_group_idinteger or null

Price group used for this customer's pricing.

payment_type_idinteger or null
payment_term_idinteger or null
require_paymentboolean
credit_limitnumber or null
open_balancenumber or null
is_ecomm_userboolean

True for Orderwerks Online (e-commerce) customers.

net_term_ecomm_userboolean
require_poboolean
standing_postring or null
hide_pricingboolean
currency_idinteger or null
notesstring or null
default_order_category_idinteger or null
route_idinteger or null
timezonestring or null
bill_to_idinteger or null
ship_to_idinteger or null
Bill_Toobject(Address)

A billing or shipping address. Additional internal fields may be present.

Ship_Toobject(Address)

A billing or shipping address. Additional internal fields may be present.

created_atstring, (date-time)
updated_atstring, (date-time)
deleted_atstring or null, (date-time)

Present only in delta-sync responses for soft-deleted customers.

Response
{
  "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"
}