Commandes (StoreOrder)

Le module StoreOrderModule gère le cycle de vie des commandes (création, mise à jour de statut, consultation).

Accès : client.app.store.order

Méthodes

`create`

Crée une nouvelle commande.

Exemple


const response = await client.app.store.order.create({
  appId: "app_id",
  apiKey: "user_api_key",
  sellerId: "seller_id",
  customerId: "customer_id",
  items: [
    {
      productId: "product_id",
      variantId: "variant_id",
      quantity: 2
    }
  ],
  shippingAddress: {
    firstName: "Jean",
    lastName: "Dupont",
    address1: "Rue 12",
    city: "Abidjan",
    country: "CI"
  }
});

Paramètres

Champs requis :

appId: ID de l’application
apiKey: Clé API de l’utilisateur
sellerId: ID du vendeur
customerId: ID du client
items: Liste des articles (produit, variant, quantité)

Champs optionnels :

shippingAddress: Adresse de livraison
billingAddress: Adresse de facturation
status: Statut initial (PENDING, PAID, etc.)

Réponse


{
  "success": true,
  "data": {
    "id": "order_id",
    "total": 5000,
    "status": "PENDING",
    "items": [...]
  }
}

`list`

Liste les commandes de l’application avec pagination, recherche et filtres avancés.

Exemple


const response = await client.app.store.order.list({
  appId: "app_id",
  apiKey: "user_api_key",
  search: "CMD-12345", // Recherche par référence ou produit
  status: "PENDING", // Filtrer par statut
  page: 1,
  limit: 20
});

Paramètres

Champs requis :

appId: ID de l’application
apiKey: Clé API de l’utilisateur

Filtres optionnels :

search: Recherche textuelle (string)
ids: Filtrer par liste d’IDs (string[])
customerId: Filtrer par client (string)
sellerId: Filtrer par vendeur (string)
status: Statut de commande (PENDING, PAID, etc.)
paymentStatus: Statut de paiement (PAID, UNPAID, etc.)
fulfillmentStatus: Statut de livraison (FULFILLED, UNFULFILLED, etc.)
page: Numéro de page (défaut: 1)
limit: Nombre d’éléments par page (défaut: 20, max: 100)

Réponse


{
  "success": true,
  "data": [
    { "id": "ord1", "ref": "CMD-12345", "status": "PENDING", ... },
    { "id": "ord2", "ref": "CMD-67890", "status": "PAID", ... }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5
  }
}

`get`

Récupère les détails d’une commande.

Exemple


const response = await client.app.store.order.get({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "order_id"
});

`update`

Met à jour une commande (souvent utilisé pour changer le statut).

Exemple


const response = await client.app.store.order.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "order_id",
  status: "PAID",
  fulfillmentStatus: "FULFILLED"
});

`delete`

Supprime une commande (généralement non recommandé pour l’historique, préférer l’annulation).

Exemple


const response = await client.app.store.order.delete({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "order_id"
});