Create Vendor

View as Markdown
Creates a vendor profile.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active project.

Request

This endpoint expects an object.
typeenumRequired
Allowed values:
display_namestringRequired
dedupe_modeenumOptionalDefaults to skip

How to handle a record matching one already in the project. skip (default) leaves the existing record untouched and answers 409 with it. overwrite updates the existing record and answers 200. add creates a separate record regardless of the match.

Allowed values:
emailstringOptionalformat: "email"
phonestringOptional
first_namestringOptional
last_namestringOptional
company_namestringOptional
currency_codestringOptional
billing_addressobjectOptional
shipping_addressobjectOptional

Response

The request used dedupe_mode: overwrite and updated the vendor it matched.

dataobject
The existing vendor the request matched.
statusboolean
messagestring

Errors

409
Conflict Error