Méthode business/deals

Last modified: 25. mars 2022

Récupérer une liste des commandes existantes

Les paramètres de recherche suivants sont possibles :

  • archive
    • ARCHIVED : commandes achevées
    • NOTARCHIVED : comandes non-archivées
  • businessType
    • PURCHASE : les commandes sortantes, pour les acheteurs
    • SALE : les commandes entrantes, pour les vendeurs
  • sort – critères de tri
    • LAST_MODIFIED : date de modification par ordre décroissant
    • SENT_DESC : date d’envoi décroissante
    • SEND_ASC : date d’envoi croissante
    • SUPPLIER : par fournisseur en ordre décroissant
    • ID : par numéro d’ordre ITscope par ordre décroissant
  • page
    • 1..n, les requêtes sont toujours limitées à 50 commandes par page

Ex : https://api.itscope.com/2.1/business/deals/deal.xml&businessType=PURCHASE

Une description de la réponse est décrite dans la description du format pour les commandes.

Recherche de commandes existantes

Les filtres suivants sont possibles :

  • keywords : recherches partielles dans « orderId », « ownOrderId » et « customerOrderId », par exemple : keywords=11SRRK
  • orderId (ou obsolète par « dealId ») : numéro d’identification unique de l’accord ITscope, par exemple : orderId=11SRRK-150126-1136
  • ownOrderId (ou obsolète par « ownDealId ») : numéro d’ordre propre attribué par le concessionnaire, par exemple : ownOrderId=54321
  • customerOrderId (ou obsolète par « customerDealId »): le numéro de commande du client final, par exemple : customerOrderId=12345
  • status : filtrez par statut de commande, par exemple : status=ADVISED
  • cartId: recherche par les identifiants du panier dans lequel se trouvent les commandes*.

* API 2.1 uniquement, voir ici.

Les paramètres de recherche suivants sont possibles :

  • archive
    • ARCHIVED : commandes achevées
    • NOTARCHIVED : comandes non-archivées
  • businessType
    • PURCHASE : les commandes sortantes, pour les acheteurs
    • SALE : les commandes entrantes, pour les vendeurs
  • sort – critères de tri
    • LAST_MODIFIED : date de modification par ordre décroissant
    • SENT_DESC : date d’envoi décroissante
    • SEND_ASC : date d’envoi croissante
    • SUPPLIER : par fournisseur en ordre décroissant
    • ID : par numéro d’ordre ITscope par ordre décroissant
  • page
    • 1..n, les requêtes sont toujours limitées à 50 commandes par page
  • lastUpdateDateFrom (API 2.1 uniquement)
    • Date de la période depuis, dans le format yyyy-MM-dd ou yyyy-MM-ddThh:mm:ss ou avec le fuseau horaire yyyy-MM-ddThh:mm:ss±hh:mm
    • voir restriction de la recherche par date de dernière modification d’une ordonnance plus bas dans cet article
  • lastUpdateDateTo (API 2.1 uniquement)
    • Période de la date jusqu’au, dans le format yyyy-MM-dd ou yyyy-MM-ddThh:mm:ss ou avec le fuseau horaire yyyy-MM-ddThh:mm:ss±hh:mm
    • voir restriction de la recherche par date de dernière modification d’une ordonnance plus bas dans cet article

Exemple de recherche pour le numéro d’ordre 54231 d’un distributeur :

https://api.itscope.com/2.1/business/deals/search/ownOrderID%3D54231/deal.xml?businessType=PURCHASE

Exemple de recherche d’un numéro de commande client final 12345 :

https://api.itscope.com/2.1/business/deals/search/customerOrderID%3D12345/deal.xml?businessType=PURCHASE

Exemple de recherche de toutes les commandes pour un panier d’achat avec l’identifiant 611e-ac7b-42c2-a3b6-2434812ede75 :

https://api.itscope.com/2.1/business/deals/search/cartId%3D611-ac7b-42c2-a3b6-2434812ede75/deal.xml?businessType=PURCHASE

Une description de la réponse est décrite dans la description du format pour les commandes.

Restreindre la recherche par date de dernière modification (API 2.1 uniquement)

Les paramètres de demande correspondants ne sont disponibles qu’à partir de l’API 2.1. Les paramètres filtrent sur le champ « statusDate » dans la commande, voir la description du format pour les commandes. La date de modification indique la date à laquelle un nouveau document de transaction a été ajouté pour la dernière fois à un ordre ou lorsque quelque chose a changé dans l’ordre.

  • lastUpdateDateFrom: l’heure de début de la période de restriction de la date de modification de l’accord au format yyyy-MM-dd ou yyyy-MM-ddThh:mm:ss ou avec le fuseau horaire yyyy-MM-ddThh:mm:ss±hh:mm. Ce n’est que si ce paramètre est défini que les offres seront filtrées en fonction de la période de changement de date.
  • lastUpdateDateTo: L’heure de fin de la période de modification de l’accord de contrainte dans le format yyyy-MM-dd ou yyyy-MM-ddThh:mm:ss ou avec le fuseau horaire yyyy-MM-ddThh:mm:ss±hh:mm. Si aucune valeur n’est transférée, la valeur par défaut est la date du jour. La valeur ne doit pas être inférieure à lastUpdateDateFrom.

Récupérer des informations générales sur une commande existante

Récupérer les informations relatives à une commande d’achat précédemment soumise sur le portail ITscope sur la base de son numéro de commande ITscope 11SRRK-150126-1136 :

Ex : https://api.itscope.com/2.1/business/deals/11SRRK-150126-1136/deal.xml

Une description de la réponse est décrite dans la description du format pour les commandes.

Archivage d’une commande existante

Archiver une commande précédemment envoyée dans le portail en utilisant son numéro d’ordre ITscope 11SRRK-150126-1136 La méthode de requête HTTP pour cette fonction est PUT, au lieu de GET :

Ex : https://api.itscope.com/2.1/business/deals/archive/11SRRK-150126-1136

L’article sur les archives explique pourquoi l’archivage doit être fait.

Confirmation d’une commande reçue en tant que distributeur (uniquement dans la version API 2.1)

Confirmer une commande reçue dans le portail en utilisant son numéro d’ordre ITscope 11SRRK-150126-1136 La méthode de requête HTTP pour cette fonction est PUT, au lieu de GET :

Ex : https://api.itscope.com/2.1/business/deals/confirm/11SRRK-150126-1136

Cela permet de définir l’ordre de statut de commande/ordre de statut de commande confirmé pour le distributeur et le donneur d’ordre. Un document de réponse à une commande au format OpenTrans 2.1 « ORDERRESPONSE » est automatiquement créé.

Il est également possible d’envoyer à ce point final une confirmation de commande au format OpenTrans 2.1 « ORDERRESPONSE« , dans ce cas il faut utiliser POST au lieu de PUT.

Créer un bon de livraison pour une transaction reçue en tant que distributeur (uniquement dans la version API 2.1)

Créer un bon de livraison pour une commande reçue dans le portail sur la base de son numéro de commande ITscope 11SRRK-150126-1136 La méthode de requête HTTP pour cette fonction est PUT, au lieu de GET :

Ex : https://api.itscope.com/2.1/business/deals/advise/11SRRK-150126-1136

Cela permet de définir la commande au statut de la commande/ordre de statut de commande dans l’expédition pour le distributeur et le donneur d’ordre. Un document de réponse à la commande généré au format OpenTrans 2.1 « DISPATCHNOTIFICATION » sera créé automatiquement.

Il est également possible d’envoyer à ce point final un propre bon de livraison au format OpenTrans 2.1 « DISPATCHNOTIFICATION« , il faut alors utiliser POST au lieu de PUT.

Facturer une commande reçue en tant que distributeur (uniquement dans la version API 2.1)

Créer une facture pour une commande reçue dans le portail sur la base de son numéro de commande ITscope 11SRRK-150126-1136 La méthode de requête HTTP pour cette fonction est PUT, au lieu de GET :

Ex : https://api.itscope.com/2.1/business/deals/invoice/11SRRK-150126-1136

Cela permet de définir la commande au statut de la commande/ordre de statut de calculé pour le distributeur et le donneur d’ordre. Un document de réponse à la commande au format OpenTrans 2.1 « INVOICE » sera automatiquement créé.

Il est également possible d’envoyer à ce point final une facture propre au format OpenTrans 2.1 « INVOICE« , il faut alors utiliser POST au lieu de PUT.

Rejeter une commande reçue en tant que distributeur (uniquement dans la version API 2.1)

Rejeter une commande reçue dans le portail sur la base de son numéro d’ordre ITscope 11SRRK-150126-1136 La méthode de requête HTTP pour cette fonction est PUT, au lieu de GET :

Ex : https://api.itscope.com/2.1/business/deals/reject/11SRRK-150126-1136

Cela permet de définir la commande au statut de la commande/ordre de statut de rejetée pour le distributeur et l’acheteur. Un document de réponse à une commande au format OpenTrans 2.1 « ORDERRESPONSE » sera automatiquement créé.

Il est également possible d’envoyer à cet Endpoint une propre annulation de commande au format OpenTrans 2.1 « ORDERRESPONSE » (voir remarque pour l’annulation de positions), il faut alors utiliser POST au lieu de PUT.

Was this article helpful?
Dislike 0
Views: 35