Adresses (AddressApi)
Le module AddressApi permet de gérer les adresses des clients de votre application.
Accès : client.address
Méthodes
list
Liste les adresses avec filtrage optionnel par client ou plateforme.
Exemple
const response = await client.address.list({
appId: "app_id",
apiKey: "user_api_key",
customerId: "cust_123"
});
// Afficher toutes les adresses
response.data.forEach(address => {
console.log(`${address.name}: ${address.address}, ${address.city}`);
});create
Crée une nouvelle adresse pour un client.
Exemple
const response = await client.address.create({
appId: "app_id",
apiKey: "user_api_key",
customerId: "cust_123",
name: "Bureau",
address: "Avenue des Entreprises 45",
city: "Abidjan",
country: "CI",
longitude: -4.0083,
latitude: 5.3364
});
console.log(`Adresse créée: ${response.data.id}`);update
Met à jour une adresse existante.
Exemple
const response = await client.address.update({
appId: "app_id",
apiKey: "user_api_key",
id: "addr_456",
name: "Nouveau Bureau",
address: "Boulevard Central 100",
city: "Abidjan"
});
console.log(`Adresse mise à jour: ${response.data.name}`);delete
Supprime une adresse.
Exemple
const response = await client.address.delete({
appId: "app_id",
apiKey: "user_api_key",
id: "addr_456"
});
if (response.data.deleted) {
console.log("Adresse supprimée avec succès");
}Gestion des erreurs
| Code erreur | Description |
|---|---|
address-not-found | L’adresse n’existe pas ou n’appartient pas à l’application |
customer-not-found | Le client n’existe pas |
not-authorized | La clé API n’a pas les droits nécessaires |
app-not-found | L’application n’existe pas |
Last updated on