Lympide

API

Tout ce qui suit permet d’appeler votre propre boutique, depuis le logiciel de votre choix et avec une clĂ© que vous Ă©mettez.

Authentification

Envoyez la clĂ© en jeton porteur, et indiquez la boutique concernĂ©e. Les clĂ©s s’émettent et se rĂ©voquent dans ParamĂštres → ClĂ©s d’intĂ©gration.

Authorization: Bearer lyk_

x-org-id: <your shop>

Une clé ne peut faire que ce pour quoi elle a été émise. Toute autre demande répond 403, et une clé révoquée répond 401 dÚs sa révocation.

Points d’entrĂ©e

GET/api/clients

Les clients de la boutique, les plus rĂ©cents d’abord.

NĂ©cessite clients.read

ParamĂštres

searchfacultatifstringat most 120 characters
includeAnonymisedfacultatifboolean
limitintegerfrom 1, to 200
cursorfacultatifstring

POST/api/clients

Ajouter un client. Le consentement marketing est dĂ©sactivĂ© sauf mention contraire, et il vous revient de l’avoir recueilli.

NĂ©cessite clients.write

Corps

namestringat most 200 characters
emailfacultatifstringemail
phonefacultatifstringat most 32 characters
companyfacultatifstringat most 200 characters
addressLinefacultatifstringat most 300 characters
postalCodefacultatifstringat most 16 characters
cityfacultatifstringat most 120 characters
countrystringat most 2 characters
siretfacultatifstringmatches ^\d{14}$
vatNumberfacultatifstringmatches ^[A-Z]{2}[0-9A-Z]{2,13}$
notesfacultatifstringat most 4000 characters
birthDatefacultatifstringmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
anniversaryDatefacultatifstringmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
attributesobject
marketingConsentboolean

GET/api/clients/{id}/loyalty

Ce qu’un client a cumulĂ© et ce que cela vaut.

NĂ©cessite clients.read

POST/api/loyalty/award

Créditer des points pour une vente déjà enregistrée.

NĂ©cessite pos.operate

Corps

clientIdstring
totalExTaxstringmatches ^\d+(\.\d{1,2})?$
saleIdstring

POST/api/loyalty/redeem

Utiliser des points sur un montant dĂ».

NĂ©cessite pos.operate

Corps

clientIdstring
pointsintegerfrom 1
amountDuestringmatches ^\d+(\.\d{1,2})?$

En cas de refus

Tout refus a la mĂȘme forme, et l’identifiant de requĂȘte est ce qu’il faut nous citer.

{
  "error": {
    "code": "forbidden",
    "message": "
",
    "details": null,
    "requestId": "
"
  }
}