API Reference

Create a Customer

post
https://vinoshipper.com/api/v3/p/customers
Body Params
string
string
string
string
dateOfBirth
object
string
string

Deprecated (Use phone field) - A 10 digit phone number

phone
object | null
alternatePhones
array of objects

Alternate phone numbers. Omit to preserve existing phones or send array to replace.

alternatePhones
string

The producer's identifier for this customer

int32

The team member ID of the person that enrolled this customer

boolean

Customer's email marketing preference. Defaults to false for new customers. Can be set to true or false, or omit to leave unchanged. You are responsible for ensuring proper consent has been collected.

boolean

Customer's SMS marketing preference. Defaults to false for new customers. For updates, set to false to opt out or omit to leave unchanged. Cannot be set to true via API due to SMS consent regulations. You are responsible for ensuring proper SMS consent has been collected.

address
object | null

The address of the location where the sale is made

date

The date the customer profile was created.

ageVerifiedBy
object

The Vinoshipper team member information

string
enum

The wholesale customer type (for updates only). Only applicable when updating an existing wholesale customer. Not allowed on create or update for non-wholesale customers.Options: DISTRIBUTOR, RETAILER, RESTAURANT, OTHER

Allowed:
Responses

401

Authentication failed

403

Insufficient permission

404

Not Found

Updated 8 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here!
Updated 8 months ago