Aperçu
L'API Storeino apporte de nouvelles améliorations, de meilleures performances et de nouvelles fonctionnalités. Ce document fournit des informations détaillées sur l'API — il est recommandé de le lire entièrement avant d'implémenter l'intégration dans un système.
Structure de l'API
Storeino fournit des points d'accès API pour les systèmes de développement et de production. Pour le développement et les tests initiaux, utilisez le point d'accès de développement.
Point d'accès API de développementhttps://api-shippings.storeino.world/api/
Point d'accès API de productionhttps://api-shippings.storeino.com/api/
En-têtes de requête
L'API Storeino nécessite les deux en-têtes suivants.
| En-tête | Valeur possible | Description |
|---|---|---|
Accept | application/json | Pour obtenir la réponse au format JSON, cet en-tête doit être envoyé avec la requête avec la valeur application/json |
X-auth-token | String | Le jeton (token) que votre entreprise reçoit après l'inscription |
Créer une commande
Nous envoyons une requête de création de commande à votre point d'accès dans ce format JSON.
Requête
{ RECEIVER: 'BADR AGRIR', //full name SELLERID: 2343, //seller ID in your company PHONE: '06xx-xx-xx-xx', //phone number string CITY: 'city of customer', //string COUNTRY: 'USA', //country of customer, string //You can find the products field only if you have the warehousing service PRODUCTS: [ { product: { _id: '23412' //id of product in your platform }, quantity: 4, unitPrice: 34 }, {...}, ], ADDRESS: 'new york 1109 road 02', //address of customer, string TOTAL_PRICE: 15, //total price, integer SERVICE: 'CASH IN DELIVERY', //string SOURCE: 'STOREINO' }
Réponse de succès
{ status: 200, data: { orderRef: 23234 //ID of the order in your platform } }
Réponse d'erreur
{ status: 400, data: { error: 'phone number not valid' } }
Importer un produit (cette API est requise uniquement si vous avez le service d'entreposage)
Nous envoyons une requête de création de produit à votre point d'accès dans ce format JSON.
Requête
{ name: 'phone', //title of the product picture: 'https/image.xx/', //url of the product description: 'new product', //description of the product source: 'STOREINO', sellerId: '', //id of the seller in your company price: 15, quantity: 122 //quantity in stock }
Réponse de succès
{ status: 200, data: { productRef: 23234, //ID of the product in your platform sellerId: 233 //ID of the seller in your platform } }
Réponse d'erreur
{ status: 400, data: { error: 'title not valid' } }
Mettre à jour le statut de la commande
Format du corps accepté
BASE-URL/companies/changeStatus?source=NAME-COMPANYRequête
// headers above are necessary { orderId: 423, //ID of the order in your database status: '', //new status note: 'delivered 12:12 AM' }
Réponse de succès
{ status: 200, data: { status: 'status changed' } }
Statuts acceptés
CONFIRMEDPREPAREDSHIPPEDDELIVEREDPAIDOUTOFSTOCKUNREACHEDCANCELEDREFUSEDAWAITING_RETURNRETURNEDPENDING
Connexion client
Format du corps accepté
BASE-URL/companies/login?source=NAME-COMPANYRequête
{ email: 'email@xxx.com', password: '......', source: 'STOREINO' }
Réponse de succès
{ status: 200, data: { sellerId: '423' //ID of the seller in your database } }
Réponse d'erreur
{ status: 400, data: { error: 'email or password is invalid' } }
Inscription client (cette API est optionnelle)
Format du corps accepté
BASE-URL/companies/register?source=NAME-COMPANYRequête
{ fullName: '', email: 'email@xxx.com', password: '......', numberPhone: '', source: 'STOREINO' }
Réponse de succès
{ status: 200, data: { sellerId: '423' //ID of the seller in your database } }
Réponse d'erreur
{ status: 400, data: { error: 'EX' } }
Valider le client (cette API est requise uniquement si vous utilisez l'API d'inscription)
Format du corps accepté
BASE-URL/companies/validation?source=NAME-COMPANYRequête
// headers above are necessary { sellerId: 423, //ID of the seller in your database confirmed: true }
Réponse de succès
{ status: 200, data: { connected: true } }