Mettre à jour les commerces et les articles

Marketplace APIs are limited access

Notre pipeline d’intégration Marketplace est actuellement au maximum de sa capacité. Nous n’acceptons pas de nouveaux partenaires pour le moment pendant que nous développons des outils libre-service pour l’intégration des commerçants. Veuillez remplir le formulaire d’intérêt pour l’intégration de Marketplace pour communiquer avec DoorDash avant de développer votre intégration.

DoorDash dispose d’un ensemble d’API qui permettent de mettre en œuvre des actions pour un commerce donné. Ces actions incluent la désactivation d’un commerce, la désactivation d’articles et d’options d’articles, l’obtention d’informations sur le commerce et l’obtention d’informations sur le menu du commerce.

Changement d’état d’activation du commerce

PUT /api/v1/stores/{merchant_supplied_id}/activation-status

DoorDash a un point d’ancrage Web qui vous permet de désactiver un commerce. Si une situation nécessite la désactivation d’un commerce, vous pourrez le faire immédiatement. Incluez le merchant_supplied_id du commerce dans les paramètres d’URL. Les charges utiles doivent avoir le format suivant; elles sont également détaillées dans le modèle StoreActivationStatus :

{
  "is_active": false,
  "reason": string from list of accepted reasons for deactivation,
  "notes": string detailing reason for deactivation
}

Un paramètre de raison obligatoire doit être transmis dans la charge utile. Cette raison est destinée à nos dossiers internes; il est donc important de préciser la « raison la plus exacte» de la désactivation du commerce. Veuillez vous assurer que ce paramètre est associé à l’une des raisons ci-dessous :

• out_of_business
• delete_store
• payment_issue
• operational_issues
• store_self_disabled_in_their_POS_portal
• store_pos_connectivity_issues

Lors de l’envoi de la demande, vous recevrez un code de réponse 200 pour confirmer que le commerce a été désactivé avec succès.

Pour réactiver le commerce, envoyez une demande PUT supplémentaire au point de terminaison. Lors de la réactivation d’un commerce, le seul paramètre requis dans la charge utile est "is_active": true.

Vous recevrez un code de réponse 200 pour confirmer que le commerce a été réactivé avec succès. Avant de réactiver un commerce, DoorDash effectue quelques vérifications. Advenant un échec de vérification, vous recevrez une réponse 400. Veuillez ne pas envoyer de réponse 400, car celle-ci échouera jusqu’à ce que le problème soit corrigé manuellement. En raison de ces vérifications, le point d’ancrage Web d’activation peut échouer pour les raisons suivantes :

• Les informations bancaires du commerce sont absentes.
• Les informations bancaires du commerce ne sont pas valides.
• Il n’existe aucun menu de PDV actif pour le commerce.

Modification de l’état d’activation d’un article par lot

PUT /api/v1/stores/{merchant_supplied_id}/item/activation-status

DoorDash a un point d’ancrage Web qui vous permet de modifier l’état des stocks des articles d’un commerce donné. Un article est en rupture de stock sera retiré du site Web de DoorDash jusqu’à ce qu’il soit de nouveau en stock. Au lieu d’utiliser les mises à jour du menu pour désactiver les articles (ce qui est une opération coûteuse), il est recommandé d’utiliser les appels suivants. Pour ce faire, veuillez inclure le merchant_supplied_id du commerce dans les paramètres d’URL. Ce paramètre s’ajoute à l’inclusion du merchant_supplied_id de l’article qui est désactivé dans la charge utile de la demande. Vous indiquerez « faux » pour désactiver un article et « vrai » pour activer un article. La charge utile doit avoir le format suivant; elle est également détaillée dans le modèle ItemActivation :

{
    "merchant_supplied_id": “string”,
    "is_active" : false
}

Modification de l’état d’activation des options d’article par lot

PUT /api/v1/stores/{merchant_supplied_id}/item_option/activation-status

DoorDash a un point d’ancrage Web qui vous permet de supprimer un item_option des stocks. Pour ce faire, veuillez inclure le merchant_supplied_id du commerce dans les paramètres d’URL. Cela s’ajoute à l’inclusion du merchant_supplied_id de item_option qui est désactivée dans la charge utile de la demande. La charge utile doit avoir le format suivant; elle est également détaillée dans le modèle ItemOptionActivation :

{
    "merchant_supplied_id": “string”,
    "is_active" : false
}

Veuillez noter que vous devez utiliser les points de terminaison pour réactiver un article ou une option d’article. Une actualisation du menu ne remettra pas automatiquement l’article en stock. L’état de menu de l’article et l’état du point d’ancrage Web de l’article doivent tous deux être définis comme vrai pour qu’un article apparaisse sur le menu. Si l’état de menu de l’article ou l’état du point d’ancrage Web de l’article est faux, l’article n’apparaîtra pas sur le menu. Des exemples de demande et de réponse se trouvent dans la Référence.

Champs importants

• is_suspended : indiquer « faux » pour désactiver un article et « vrai » pour activer un article
• price : Nombre entier. Si vous souhaitez définir le prix à 5,00 $, vous devez envoyer 500.

Codes d’état de réponse pour item et item_option :

Code d’état	Détails
200	Succès
400	Mauvaise demande (si l’un des articles ne se met pas à jour, la réponse 400 doit être retournée)
401	Erreur d’authentification
403	Non autorisé à modifier ce commerce
404	Commerce non trouvé
429	Limite de transmission de données dépassée
500	Erreur interne du serveur

Détails de la réponse pour chaque entité

Réponse	Détails
Success
Not Found	Item not found
Erreur du serveur	Erreur interne du serveur

Veuillez réessayer la demande uniquement si une réponse 500 est renvoyée. Nous vous recommandons de réessayer 3 fois avec un délai exponentiel de 0,5 seconde

Récupération des informations sur le commerce (GET)

GET api/v1/stores/{merchant_supplied_id}

Les partenaires peuvent utiliser ce point de terminaison pour récupérer des informations en direct sur un commerce pour les emplacements configurés dans l’intégration. Ce point de terminaison peut être utile pour vérifier les informations suivantes :

Quel protocole de commande (tablette, PDV, etc.) ce commerce utilise-t-il actuellement? Quelle est la longueur maximale des instructions spéciales définie pour ce commerce? Mon commerce est-il temporairement/définitivement désactivé? Pourquoi? L’émission automatique des commandes (AOR) est-elle activée dans ce commerce?

Les détails de l’objet de réponse se trouvent dans notre documentation Swagger, et nous avons également inclus un exemple dans la section Référence de ce document.

Récupération des détails du menu du commerce (GET)

GET api/v1/stores/{merchant_supplied_id}/menu_details

Les partenaires peuvent utiliser ce point de terminaison pour récupérer des informations en direct sur un menu pour les emplacements configurés dans l’intégration. Ce point de terminaison peut être utile pour vérifier les informations suivantes concernant les menus actifs dans les commerces :

• Quels sont les identifiants de menu liés à cet emplacement?
• Ce menu est-il actuellement actif?
• À quand remonte la dernière mise à jour réussie de ce menu?
• Quelles sont les heures spéciales/régulières pour ce menu?
• Ce menu a-t-il été créé avec un PDV ou avec une autre méthode?
• Quelle est l’URL d’aperçu du menu?

Les détails de l’objet de réponse se trouvent dans notre documentation Swagger, et nous avons également inclus un exemple dans la section Référence de ce document.