Référence API

Documentation des endpoints REST de l'API Shopimind v1 : ressources, schémas de requête, codes de réponse, et exemples exécutables.

Documentation en bêta

Cette référence est en cours de finalisation. Les ressources principales (contacts, clients, commandes, produits, données personnalisées) sont déjà couvertes. À venir prochainement : événements externes, webhooks, SDKs officiels JavaScript & PHP, ainsi qu'une page dédiée aux codes d'erreur. Si une opération vous semble mal documentée, merci de la signaler à votre interlocuteur Shopimind.

Authentification

Toutes les requêtes nécessitent un header spm-api-key valide. Voir la page d'authentification pour générer votre clé.

Base URL

https://core.shopimind.com/v1

Le préfixe /v1 est inclus dans chaque path de la référence — toutes les routes commencent donc par /v1/... (ex. /v1/customers, /v1/orders/{order_id}).

Conventions

Format des réponses

L'enveloppe JSON dépend du type d'opération. Trois formes sont utilisées :

Récupération d'une ressource unique (GET /v1/{resource}/{id})

{
  "statusCode": 200,
  "data": { /* l'objet demandé */ }
}

Récupération d'une liste (GET /v1/{resource})

{
  "statusCode": 200,
  "data": [ /* tableau d'objets */ ],
  "meta": {
    "pagination": {
      "total_items": 100,
      "items_per_page": 10,
      "total_pages": 10,
      "current_page": 1,
      "offset": 0,
      "has_previous_page": false,
      "has_next_page": true,
      "next_page": 2,
      "previous_page": null
    },
    "generated_at": "2026-05-07T14:32:11.000Z"
  }
}

Écritures en lot (POST / PUT / bulk-delete)

{
  "statusCode": 200,
  "sent_count": 18,
  "rejected_count": 2,
  "rejected_items": [ /* index, payload original, erreurs de validation */ ]
}

Les items rejetés n'interrompent pas le batch : seuls les items valides sont acceptés. Le traitement effectif est asynchrone — un 200 confirme l'acceptation, pas la visibilité immédiate sur les lectures suivantes.

Pagination, filtrage, tri, projection

Les endpoints de listing acceptent les paramètres standard limit, offset, filters, order, et fields. Le paramètre fields accepte une projection sur la ressource — utile pour limiter la taille des réponses aux champs réellement utilisés.

Idempotence des suppressions

Les delete* et bulkDelete* sont idempotents : supprimer un identifiant inconnu réussit silencieusement, sans erreur.

Versionnement

L'API est versionnée par préfixe d'URL (/v1). Toute évolution incompatible introduira une nouvelle version (/v2, …) ; la version courante reste maintenue le temps de la migration.

Ressources disponibles

Les endpoints sont regroupés en quatre catégories accessibles via la sidebar :

• Contacts et clients — Contacts, Customers, Customers groups, Lists, Contact consent history, Contact messages reject.
• Données personnalisées — Custom data definitions, Custom data records.
• Commandes — Orders, Carts, Orders carriers, Orders statuses, Vouchers.
• Produits — Products, Products categories, Products manufacturers.

Chaque endpoint expose son schéma de requête, les paramètres acceptés, les codes de réponse possibles, et un exemple exécutable en cURL, Node.js et PHP.