Customer display name
This is usually a concatenation of first name and last name
Default: null
languageall of · nullableOptionnel
Language preference of the customer
Default: null
string · enumOptionnelValeurs possibles:
phoneNumberstring · nullableRequis
Phone number of the customer
Default: null
emailstring · nullableRequis
Email address of the customer
Default: null
emailBouncedbooleanRequis
Indicates if the customer's email has bounced
civilitystring · nullableRequis
Civility of the customer (e.g., Mr., Ms., etc.)
Default: null
emailOptinbooleanRequis
Indicates if the customer has opted in for email communications
smsOptinbooleanRequis
Indicates if the customer has opted in for SMS communications
zenchefIdstring · nullableRequis
ID of the customer in Zenchef system
Default: null
ubereatsIdstring · nullableRequis
ID of the customer in UberEats system
Default: null
deliverooIdstring · nullableRequis
ID of the customer in Deliveroo system
Default: null
zeltyIdstring · nullableRequis
ID of the customer in Zelty system
Default: null
sevenroomsIdstring · nullableRequis
ID of the customer in Sevenrooms system
Default: null
metaIdstring · nullableRequis
ID of the customer in Meta system (Facebook/Instagram)
Default: null
mewsIdstring · nullableRequis
ID of the customer in Mews system
Default: null
oracleIdstring · nullableRequis
ID of the customer in Oracle system
Default: null
partoucheIdstring · nullableRequis
ID of the customer in Partouche system
Default: null
comoIdstring · nullableRequis
ID of the customer in Como system
Default: null
theForkIdstring · nullableRequis
ID of the customer in TheFork system
Default: null
chr365Idstring · nullableRequis
ID of the customer in Chr365 system
Default: null
typestring · enum · nullableRequis
Type of the customer (e.g., Individual, Company, etc.)
Default: nullValeurs possibles:
feedbackCountnumberRequis
Number of feedbacks provided by the customer
purchaseCountnumberRequis
Number of purchases made by the customer
averageFeedbackRatingstring · nullableRequis
Average feedback rating given by the customer
Default: null
400
Invalid input format.
401
Unauthorized
404
Customer not found.
get
/partners/customer
Import a single customer
post
When creating a customer, if the email/phoneNumber pair already exists, no new record is created. Only previously empty (null) data is then filled in; the other fields remain unchanged.
Paramètres d'en-tête
X-API-KEYstringRequis
Partner API Key
X-API-SECRETstringRequis
Partner API Secret
Corps
descriptionstring · nullableOptionnel
Description of the customer
companystring · nullableOptionnel
Company name of the customer
firstNamestring · nullableOptionnel
First name of the customer
lastNamestring · nullableOptionnel
Last name of the customer
displayNamestring · nullableOptionnel
Display name of the customer
Usually a concatenation of first name and last name
phoneNumberstring · nullableOptionnel
Phone number of the customer
emailstring · email · nullableOptionnel
Email address of the customer
civilitystring · nullableOptionnel
Civility of the customer (e.g., Mr., Ms., etc.)
languageall of · nullableOptionnel
Language preference of the customer
string · enumOptionnelValeurs possibles:
metadataobjectOptionnel
Additional metadata to store with the customer
This is a key-value pair object where both keys and values are strings
smsOptinboolean · nullableOptionnel
SMS opt-in status of the customer
emailOptinboolean · nullableOptionnel
Email opt-in status of the customer
zenchefIdstring · nullableOptionnel
ID of the customer in Zenchef system
ubereatsIdstring · nullableOptionnel
ID of the customer in UberEats system
deliverooIdstring · nullableOptionnel
ID of the customer in Deliveroo system
zeltyIdstring · nullableOptionnel
ID of the customer in Zelty system
sevenroomsIdstring · nullableOptionnel
ID of the customer in Sevenrooms system
metaIdstring · nullableOptionnel
ID of the customer in Meta system (Facebook/Instagram)
mewsIdstring · nullableOptionnel
ID of the customer in Mews system
oracleIdstring · nullableOptionnel
ID of the customer in Oracle system
partoucheIdstring · nullableOptionnel
ID of the customer in Partouche system
comoIdstring · nullableOptionnel
ID of the customer in Como system
theForkIdstring · nullableOptionnel
ID of the customer in TheFork system
chr365Idstring · nullableOptionnel
ID of the customer in Chr365 system
Réponses
201
The customer has been successfully imported.
application/json
400
Invalid input format.
401
Unauthorized
post
/partners/customer
List customers
post
Paramètres d'en-tête
X-API-KEYstringRequis
Partner API Key
X-API-SECRETstringRequis
Partner API Secret
Corps
limitnumber · min: 1 · max: 100Optionnel
Pagination limit
Default: 10
pagenumber · min: 1Optionnel
Page to retrieve
Default: 1
Réponses
201
The customers have been successfully listed.
application/json
400
Invalid input format.
401
Unauthorized
post
/partners/customer/list
Import a batch of customer
post
When creating a customer, if the email/phoneNumber pair already exists, no new record is created. Only previously empty (null) data is then filled in; the other fields remain unchanged.