API Reference

Filter and List Customers

post
https://vinoshipper.com/api/v3/p/customers/list
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Search customers for this term. Note: Other filters are not applied when this is set.

string

Include customers with a last name starting with this letter

string

Include customers with shipping address or club membership address in state

boolean
required

True if only club members should be included

wineClubIds
array of int32s

Only include customers within these clubs

wineClubIds
string
enum

Only include customers with a matching club membership status

Allowed:
tagIds
array of int64s

Only include customers with these tags

tagIds
string
enum

Filter by customer type: RETAIL or WHOLESALE

Allowed:
int32
required
≥ 1

Page offset, starting at 1

int32
required
Defaults to 25

Size of each page

Responses

401

Authentication failed

403

Insufficient permission

404

Not Found

Updated about 2 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated about 2 months ago

Did this page help you?