Commande de produit API ouverte

Rversion finale: Zurich

Mis à jour 31 juil. 2025

165 minutes de lecture

L’API Product Order Open fournit des points de terminaison qui activent un mécanisme standardisé pour passer des commandes de produits.

Une commande de produit est créée en fonction d’une offre de produit définie et publiée dans un catalogue de produits. L’offre de produit identifie le produit ou l’ensemble de produits disponibles pour un client et comprend les caractéristiques pertinentes du produit qui capturent les options uniques d’un produit, ainsi que d’autres attributs pertinents tels que le prix, les conditions contractuelles et la disponibilité.

Pour accéder à cette API, le module d’extension Order Management for Telecommunications (sn_ind_tmt_orm) doit être activé.

Cette API est fournie dans l’espace de noms sn_ind_tmt_orm .

L’utilisateur appelant doit avoir le rôle sn_ind_tmt_orm.order_integrator.

Cette API peut être étendue pour effectuer des personnalisations autour des paramètres requis, de la validation du corps de la demande, des opérations REST supplémentaires et des mappages de champs. Pour plus d'informations, voir le Guide du développeur Open API de la commande de produit.

L’API Product Order Open est une ServiceNow® implémentation de la spécification REST de l’API de gestion des commandes de produits TMF622 de TM Forum et est certifiée par TM Forum.

Logo de conformité TMF

API ouverte de commande de produit : GET /sn_ind_tmt_orm/order/productOrder

Récupère toutes les commandes de produits.

Ce point de terminaison récupère les informations de commande à partir des tables suivantes :

Commande de clients [sn_ind_tmt_orm_order]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
Contact d’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]
Éléments liés à la ligne de commande [sn_ind_tmt_orm_order_line_related_items]

Format d'URL

URL par défaut : /api/sn_ind_tmt_orm/order/productOrder

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 2. Paramètres de requête
Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : tous les champs renvoyés.
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la offset récupération de l’enregistrement. Type de données : nombre Par défaut : 20 Maximum : 100
décalage	Index de début auquel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Type de données : nombre Par défaut : 0
État	Filtrer les commandes par état. Seules les commandes dont l’état correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne Par défaut : ne pas trier par état.

Tableau 3. Paramètres du corps de la demande (JSON)
Nom	Description
Aucun

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes
En-tête	Description
Aucun

Tableau 5. En-têtes de réponses
En-tête	Description
Plage de contenu	Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si `offset=2` and `limit=3`, la valeur de l’en-tête Content-Range est `les éléments 3 à 5`.
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Lien	Contient les liens suivants pour parcourir les résultats de la requête. premier dernier suivant previous
X-Total-Count	Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état
Code d'état	Description
200	Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination).
206	Ressource partielle retournée en réponse (avec pagination).
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

Paramètres de corps de réponse (JSON)


Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne
channel.name	Nom du canal à utiliser pour vendre les produits associés. Type de données : chaîne
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne
expectedCompletionDate	Date à laquelle la commande sera terminée. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de produit. Type de données : chaîne
id	Sys_id de la commande de produit. Type de données : chaîne
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.auteur	Nom d’utilisateur de la personne qui a rédigé la note associée. Type de données : chaîne
note.date	Date de création de la note. Type de données : chaîne
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
orderCurrency	Code de devise pour la commande et les éléments de ligne de bon de commande. Type de données : chaîne
PONR	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs possibles : vrai : le point de non-retour de la commande a été atteint. faux : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
produitÉlémentCommande.action	Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
productOrderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne
productOrderItem.externalProductInventory	Liste des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire de produits. Type de données : chaîne
productOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.valeur	Prix du produit, taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
productOrderItem.ponr	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs possibles : vrai : le point de non-retour de la commande a été atteint. faux : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
produitCommandeÉlément.produit	Description des détails d’instance du produit acheté par le client. Type de données : objet `"product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
productOrderItem.product.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Seules les caractéristiques du produit qui value sont différentes de la sont previousValue renvoyées. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
productItemOrder.product.productCharacteristic.valueType	Type de valeur caractéristique. Valeurs possibles : Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Tableau.Test sur ligne unique Case à cocher Choix Date, adresse E-mail Entier,Date/heure Objet Texte sur ligne unique Oui/Non Type de données : chaîne
produitCommandeÉlément.produit.produitRelation	Liste des détails de relation de produit pour un élément de ligne de commande. Type de données : tableau d’objets `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	Sys_id ou sn_prd_invt_external_id de l’inventaire des produits. Type de données : chaîne Table : dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory].
produitÉlémentCommande.produit.produitRelationship.relationshipType	Type de relation entre l’élément de ligne de commande et l’inventaire des produits. Valeur possible : nécessite Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalId	Version initiale de la spécification du produit. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
élémentcommandeproduit.produit.spécificationsproduit.versioninterne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
élémentcommandeproduit.produit.spécifications.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne
productOrderItem.product.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Type de données : chaîne
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalId	Version initiale de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.quantity	Nombre d’éléments de produit achetés. Type de données : nombre
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
productOrderItem.state	État de la commande de l’élément de produit associé. Type de données : chaîne
productOrderItem.version	Version de la commande. Type de données : chaîne
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
État	État actuel de la commande. Type de données : chaîne
version	Version de la commande. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Demande cURL

Cet exemple récupère toutes les commandes de produits.

curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder' \
--user 'username':'password'

Corps de la réponse.

[
   {
      "id": "8d75939453126010a795ddeeff7b126a",
      "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
      "ponr": "false",
      "orderCurrency": "USD",
      "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
      "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
      "requestedStartDate": "2020-05-03T08:13:59.000Z",
      "channel": [
         {
            "id": "1",
            "name": "Agent Assist"
         }
      ],
      "note": [
         {
            "author": "System Administrator",
            "date": "2021-02-25T14:22:07.000Z",
            "text": "This is a TMF product order illustration no 2"
         },
         {
            "author": "System Administrator",
            "date": "2021-02-25T14:22:06.000Z",
            "text": "This is a TMF product order illustration"
         }
      ],
      "productOrderItem": [
         {
            "id": "POI130",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "actionReason": "adding service package OLI",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 20
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "Security Type",
                     "valueType": "Choice",
                     "value": "Base",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "a6514bd3534560102f18ddeeff7b1247",
                  "name": "SD-WAN Security",
                  "version": "v1",
                  "internalVersion": "1",
                  "internalId": "a6514bd3534560102f18ddeeff7b1247",
                  "@type": "ProductSpecificationRef"
               },
               "relatedParty": [
                  {
                     "id": "4175939453126010a795ddeeff7b127d",
                     "name": "John Smith",
                     "email": "abc2@example.com",
                     "phone": "32456768",
                     "@type": "RelatedParty",
                     "@referredType": "OrderLineItemContact"
                  },
                  {
                     "id": "c175939453126010a795ddeeff7b127c",
                     "name": "Joe Doe",
                     "email": "abc@example.com",
                     "phone": "1234567890",
                     "@type": "RelatedParty",
                     "@referredType": "OrderLineItemContact"
                  }
               ]
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering",
               "version": "v1",
               "internalId": "69017a0f536520103b6bddeeff7b127d",
               "internalVersion": "1"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI100",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productSpecification": {
                  "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
                  "name": "SD-WAN Service Package",
                  "version": "v1",
                  "internalVersion": "1",
                  "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
                  "@type": "ProductSpecificationRef"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering",
               "version": "v1",
               "internalId": "69017a0f536520103b6bddeeff7b127d",
               "internalVersion": "1"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI130",
                  "relationshipType": "HasChild"
               },
               {
                  "id": "POI120",
                  "relationshipType": "HasChild"
               },
               {
                  "id": "POI110",
                  "relationshipType": "HasChild"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI120",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 20
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "CPE Type",
                     "valueType": "Choice",
                     "value": "Physical",
                     "previousValue": ""
                  },
                  {
                     "name": "WAN Optimization",
                     "valueType": "Choice",
                     "value": "Advance",
                     "previousValue": ""
                  },
                  {
                     "name": "Routing",
                     "valueType": "Choice",
                     "value": "Premium",
                     "previousValue": ""
                  },
                  {
                     "name": "CPE Model",
                     "valueType": "Choice",
                     "value": "ASR",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "39b627aa53702010cd6dddeeff7b1202",
                  "name": "SD-WAN Edge Device",
                  "version": "v1",
                  "internalVersion": "1",
                  "internalId": "39b627aa53702010cd6dddeeff7b1202",
                  "@type": "ProductSpecificationRef"
               },
               "productRelationship": [
                  {
                     "id": "326d13f45b5620102dff5e92dc81c785",
                     "relationshipType": "Requires"
                  }
               ]
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "69017a0f536520103b6bddeeff7b127d"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               },
               {
                  "id": "POI110",
                  "relationshipType": "Requires"
               }       
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI110",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 5
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "Tenancy",
                     "valueType": "Choice",
                     "value": "Base (10 site)",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "216663aa53702010cd6dddeeff7b12b5",
                  "name": "SD-WAN Controller",
                  "version": "v1",
                  "internalVersion": "1",
                  "internalId": "216663aa53702010cd6dddeeff7b12b5",
                  "@type": "ProductSpecificationRef"
               },
               "place": {
                  "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                  "@type": "Place"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering",
               "version": "v1",
               "internalId": "69017a0f536520103b6bddeeff7b127d",
               "internalVersion": "1"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         }
      ],
      "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
      "state": "in_progress",
      "version": "1",
      "@type": "ProductOrder"
   }
]

API ouverte de commande de produit : GET /sn_ind_tmt_orm/order/productOrder/{id}

Récupère la commande de produits spécifiée.

Ce point de terminaison récupère les informations de commande à partir des tables suivantes :

Commande de clients [sn_ind_tmt_orm_order]
Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
Contact d’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]
Éléments liés à la ligne de commande [sn_ind_tmt_orm_order_line_related_items]

Format d'URL

URL par défaut : /api/sn_ind_tmt_orm/order/productOrder/{id}

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès
Nom	Description
id	Sys_id ou external_id de la commande de client à récupérer. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]

Tableau 8. Paramètres de requête
Nom	Description
Aucun

Tableau 9. Paramètres du corps de la demande (JSON)
Nom	Description
Aucun

En-têtes

Tableau 10. En-têtes de demandes
En-tête	Description
Aucun

Tableau 11. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état
Code d'état	Description
200	Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination). La réponse est retournée avec un message d’erreur si la commande sélectionnée présente des problèmes de traitement. Une réponse OK 200 se produit si la commande se trouve dans la table File d’attente entrante [sn_tmt_core_inbound_queue] en attente que le planificateur sélectionne l’enregistrement à traiter. Le champ de message d’erreur inclut les détails de l’enregistrement. Par exemple : `{ "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] }` Une réponse OK 200 se produit si la création d’une commande échoue et que l’enregistrement de la table File d’attente entrante [sn_tmt_core_inbound_queue] est dans un état d’erreur. Le champ de message d’erreur inclut les détails de l’enregistrement de table de file d’attente entrante. Par exemple : `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
206	Ressource partielle retournée en réponse (avec pagination).
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

Paramètres de corps de réponse (JSON)


Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne
channel.name	Nom du canal à utiliser pour vendre les produits associés. Type de données : chaîne
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne
expectedCompletionDate	Date à laquelle la commande sera terminée. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de produit. Type de données : chaîne
id	Sys_id de la commande de produit. Type de données : chaîne
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.auteur	Nom d’utilisateur de la personne qui a rédigé la note associée. Type de données : chaîne
note.date	Date de création de la note. Type de données : chaîne
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
orderCurrency	Code de devise pour la commande et les éléments de ligne de bon de commande. Type de données : chaîne
PONR	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs possibles : vrai : le point de non-retour de la commande a été atteint. faux : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
produitÉlémentCommande.action	Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
productOrderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne
productOrderItem.externalProductInventory	Liste des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire de produits. Type de données : chaîne
productOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.valeur	Prix du produit, taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
productOrderItem.ponr	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs possibles : vrai : le point de non-retour de la commande a été atteint. faux : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
produitCommandeÉlément.produit	Description des détails d’instance du produit acheté par le client. Type de données : objet `"product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
productOrderItem.product.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Seules les caractéristiques du produit qui value sont différentes de la sont previousValue renvoyées. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
productItemOrder.product.productCharacteristic.valueType	Type de valeur caractéristique. Valeurs possibles : Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Tableau.Test sur ligne unique Case à cocher Choix Date, adresse E-mail Entier,Date/heure Objet Texte sur ligne unique Oui/Non Type de données : chaîne
produitCommandeÉlément.produit.produitRelation	Liste des détails de relation de produit pour un élément de ligne de commande. Type de données : tableau d’objets `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	Sys_id ou sn_prd_invt_external_id de l’inventaire des produits. Type de données : chaîne Table : dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory].
produitÉlémentCommande.produit.produitRelationship.relationshipType	Type de relation entre l’élément de ligne de commande et l’inventaire des produits. Valeur possible : nécessite Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalId	Version initiale de la spécification du produit. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
élémentcommandeproduit.produit.spécificationsproduit.versioninterne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
élémentcommandeproduit.produit.spécifications.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne
productOrderItem.product.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Type de données : chaîne
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalId	Version initiale de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.quantity	Nombre d’éléments de produit achetés. Type de données : nombre
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
productOrderItem.state	État de la commande de l’élément de produit associé. Type de données : chaîne
productOrderItem.version	Version de la commande. Type de données : chaîne
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
État	État actuel de la commande. Type de données : chaîne
version	Version de la commande. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Demande cURL

Cet exemple récupère une commande de produit spécifiée.

curl -X GET "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"

Corps de la réponse.

{
   "id": "8d75939453126010a795ddeeff7b126a",
   "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
   "ponr": "false",
   "orderCurrency": "USD",
   "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
   "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
   "requestedStartDate": "2020-05-03T08:13:59.000Z",
   "channel": [
      {
         "id": "1",
         "name": "Agent Assist"
      }
   ],
   "note": [
      {
         "author": "System Administrator",
         "date": "2021-02-25T14:22:07.000Z",
         "text": "This is a TMF product order illustration no 2"
      },
      {
         "author": "System Administrator",
         "date": "2021-02-25T14:22:06.000Z",
         "text": "This is a TMF product order illustration"
      }
   ],
   "productOrderItem": [
      {
         "id": "POI130",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 20
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "Security Type",
                  "valueType": "Choice",
                  "value": "Base",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247",
               "@type": "ProductSpecificationRef"
            },
            "relatedParty": [
               {
                  "id": "4175939453126010a795ddeeff7b127d",
                  "name": "John Smith",
                  "email": "abc2@example.com",
                  "phone": "32456768",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               },
               {
                  "id": "c175939453126010a795ddeeff7b127c",
                  "name": "Joe Doe",
                  "email": "abc@example.com",
                  "phone": "1234567890",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               }
            ]
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI100",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason":"adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productSpecification": {
               "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
               "name": "SD-WAN Service Package",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
               "@type": "ProductSpecificationRef"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI130",
               "relationshipType": "HasChild"
            },
            {
               "id": "POI120",
               "relationshipType": "HasChild"
            },
            {
               "id": "POI110",
               "relationshipType": "HasChild"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI120",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 20
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "CPE Type",
                  "valueType": "Choice",
                  "value": "Physical",
                  "previousValue": ""
               },
               {
                  "name": "WAN Optimization",
                  "valueType": "Choice",
                  "value": "Advance",
                  "previousValue": ""
               },
               {
                  "name": "Routing",
                  "valueType": "Choice",
                  "value": "Premium",
                  "previousValue": ""
               },
               {
                  "name": "CPE Model",
                  "valueType": "Choice",
                  "value": "ASR",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202",
               "@type": "ProductSpecificationRef"
            }, 
            "productRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ]
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "69017a0f536520103b6bddeeff7b127d"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            },
            {
               "id": "POI110",
               "relationshipType": "Requires"
            }    
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI110",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 5
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "Tenancy",
                  "valueType": "Choice",
                  "value": "Base (10 site)",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5",
               "@type": "ProductSpecificationRef"
            },
            "place": {
               "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
               "@type": "Place"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "state": "in_progress",
   "version": "1",
   "@type": "ProductOrder"
}

API ouverte de commande de produit : GET /sn_ind_tmt_orm/productorder

Récupère toutes les commandes de produits.

Important :

À partir de la mise en Tokyo production, ce point de terminaison est obsolète. La nouvelle version de ce point de terminaison est API ouverte de commande de produit : GET /sn_ind_tmt_orm/order/productOrder.

Ce point de terminaison récupère les informations de commande à partir des tables suivantes :

Commande de clients [sn_ind_tmt_orm_order]
Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
Contact d’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]

Format d'URL

URL par défaut : /api/sn_ind_tmt_orm/productorder

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 14. Paramètres de requête
Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : tous les champs renvoyés.
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la offset récupération de l’enregistrement. Type de données : nombre Par défaut : 20 Maximum : 100
décalage	Index de début auquel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Type de données : nombre Par défaut : 0
État	Filtrer les commandes par état. Seules les commandes dont l’état correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne Par défaut : tous les états renvoyés.

Tableau 15. Paramètres du corps de la demande (JSON)
Nom	Description
Aucun

En-têtes

Tableau 16. En-têtes de demandes
En-tête	Description
Aucun

Tableau 17. En-têtes de réponses
En-tête	Description
Plage de contenu	Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si `offset=2` and `limit=3`, la valeur de l’en-tête Content-Range est `les éléments 3 à 5`.
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Lien	Contient les liens suivants pour parcourir les résultats de la requête. premier dernier suivant previous
X-Total-Count	Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état
Code d'état	Description
200	Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination).
206	Ressource partielle retournée en réponse (avec pagination).
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

Paramètres de corps de réponse (JSON)


Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne
channel.name	Nom du canal à utiliser pour vendre les produits associés. Type de données : chaîne
expectedCompletionDate	Date à laquelle la commande sera terminée. Type de données : chaîne
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": { "author": "String", "date": "String", "text": "String" }`
note.auteur	Nom d’utilisateur de la personne qui a rédigé la note associée. Type de données : chaîne
note.date	Date de création de la note. Type de données : chaîne
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
PONR	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs possibles : vrai : le point de non-retour de la commande a été atteint. faux : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
produitÉlémentCommande.action	Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
productOrderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.valeur	Prix du produit, taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
productOrderItem.ponr	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs possibles : vrai : le point de non-retour de la commande a été atteint. faux : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
produitCommandeÉlément.produit	Description des détails d’instance du produit acheté par le client. Type de données : objet `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
productOrderItem.product.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Seules les caractéristiques du produit qui value sont différentes de la sont previousValue renvoyées. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
productItemOrder.product.productCharacteristic.valueType	Type de valeur caractéristique. Valeurs possibles : Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Tableau.Test sur ligne unique Case à cocher Choix Date, adresse E-mail Entier,Date/heure Objet Texte sur ligne unique Oui/Non Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne
productOrderItem.product.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Type de données : chaîne
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.quantity	Nombre d’éléments de produit achetés. Type de données : nombre
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
productOrderItem.state	État de la commande de l’élément de produit associé. Type de données : chaîne
productOrderItem.version	Version de la commande. Type de données : chaîne
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
État	État actuel de la commande. Type de données : chaîne
version	Version de la commande. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Demande cURL

Cet exemple récupère toutes les commandes de produits.

curl --location --request GET 'https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder' \
--user 'username':'password'

Corps de la réponse.

[
   {
      "id": "8d75939453126010a795ddeeff7b126a",
      "ponr": "false",
      "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
      "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
      "requestedStartDate": "2020-05-03T08:13:59.000Z",
      "channel": [
         {
            "id": "1",
            "name": "Agent Assist"
         }
      ],
      "note": [
         {
            "author": "System Administrator",
            "date": "2021-02-25T14:22:07.000Z",
            "text": "This is a TMF product order illustration no 2"
         },
         {
            "author": "System Administrator",
            "date": "2021-02-25T14:22:06.000Z",
            "text": "This is a TMF product order illustration"
         }
      ],
      "productOrderItem": [
         {
            "id": "POI130",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "actionReason": "adding service package OLI",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 20
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "Security Type",
                     "valueType": "Choice",
                     "value": "Base",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "a6514bd3534560102f18ddeeff7b1247",
                  "name": "SD-WAN Security",
                  "@type": "ProductSpecificationRef"
               },
               "relatedParty": [
                  {
                     "id": "4175939453126010a795ddeeff7b127d",
                     "name": "John Smith",
                     "email": "abc2@example.com",
                     "phone": "32456768",
                     "@type": "RelatedParty",
                     "@referredType": "OrderLineItemContact"
                  },
                  {
                     "id": "c175939453126010a795ddeeff7b127c",
                     "name": "Joe Doe",
                     "email": "abc@example.com",
                     "phone": "1234567890",
                     "@type": "RelatedParty",
                     "@referredType": "OrderLineItemContact"
                  }
               ]
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI100",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productSpecification": {
                  "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
                  "name": "SD-WAN Service Package",
                  "@type": "ProductSpecificationRef"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI130",
                  "relationshipType": "HasChild"
               },
               {
                  "id": "POI120",
                  "relationshipType": "HasChild"
               },
               {
                  "id": "POI110",
                  "relationshipType": "HasChild"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI120",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "actionReason":"adding service package OLI",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 20
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "CPE Type",
                     "valueType": "Choice",
                     "value": "Physical",
                     "previousValue": ""
                  },
                  {
                     "name": "WAN Optimization",
                     "valueType": "Choice",
                     "value": "Advance",
                     "previousValue": ""
                  },
                  {
                     "name": "Routing",
                     "valueType": "Choice",
                     "value": "Premium",
                     "previousValue": ""
                  },
                  {
                     "name": "CPE Model",
                     "valueType": "Choice",
                     "value": "ASR",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "39b627aa53702010cd6dddeeff7b1202",
                  "name": "SD-WAN Edge Device",
                  "@type": "ProductSpecificationRef"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         },
         {
            "id": "POI110",
            "ponr": "false",
            "quantity": 1,
            "action": "add",
            "actionReason": "adding service package OLI",
            "itemPrice": [
               {
                  "priceType": "recurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "INR",
                        "value": 0
                     }
                  }
               },
               {
                  "priceType": "nonRecurring",
                  "price": {
                     "taxIncludedAmount": {
                        "unit": "USD",
                        "value": 5
                     }
                  }
               }
            ],
            "product": {
               "@type": "Product",
               "productCharacteristic": [
                  {
                     "name": "Tenancy",
                     "valueType": "Choice",
                     "value": "Base (10 site)",
                     "previousValue": ""
                  }
               ],
               "productSpecification": {
                  "id": "216663aa53702010cd6dddeeff7b12b5",
                  "name": "SD-WAN Controller",
                  "@type": "ProductSpecificationRef"
               },
               "place": {
                  "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                  "@type": "Place"
               }
            },
            "productOffering": {
               "id": "69017a0f536520103b6bddeeff7b127d",
               "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
               {
                  "id": "POI100",
                  "relationshipType": "HasParent"
               }
            ],
            "state": "in_progress",
            "version": "1",
            "@type": "ProductOrderItem"
         }
      ],
      "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
      "state": "in_progress",
      "version": "1",
      "@type": "ProductOrder"
   }
]

API ouverte de commande de produit : GET /sn_ind_tmt_orm/productorder/{id}

Récupère la commande de produits spécifiée.

Important :

Ce point de terminaison récupère les informations de commande à partir des tables suivantes :

Commande de clients [sn_ind_tmt_orm_order]
Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
Contact d’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]

Format d'URL

URL par défaut : /api/sn_ind_tmt_orm/productorder/{id}

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès
Nom	Description
id	Sys_id ou external_id de la commande de client à récupérer. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]

Tableau 20. Paramètres de requête
Nom	Description
Aucun

Tableau 21. Paramètres du corps de la demande (JSON)
Nom	Description
Aucun

En-têtes

Tableau 22. En-têtes de demandes
En-tête	Description
Aucun

Tableau 23. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 24. Codes d'état
Code d'état	Description
201	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Peut être dû à l’une des raisons suivantes : Paramètre de requête manquant URI non valide
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)


Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne
channel.name	Nom du canal à utiliser pour vendre les produits associés. Type de données : chaîne
expectedCompletionDate	Date à laquelle la commande sera terminée. Type de données : chaîne
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : objet `"note": { "author": "String", "date": "String", "text": "String" }`
note.auteur	Nom d’utilisateur de la personne qui a rédigé la note associée. Type de données : chaîne
note.date	Date de création de la note. Type de données : chaîne
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
PONR	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs possibles : vrai : le point de non-retour de la commande a été atteint. faux : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
produitÉlémentCommande.action	Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
productOrderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.valeur	Prix du produit, taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
productOrderItem.ponr	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs possibles : vrai : le point de non-retour de la commande a été atteint. faux : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
produitCommandeÉlément.produit	Description des détails d’instance du produit acheté par le client. Type de données : objet `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
productOrderItem.product.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Seules les caractéristiques du produit qui value sont différentes de la sont previousValue renvoyées. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
productItemOrder.product.productCharacteristic.valueType	Type de valeur caractéristique. Valeurs possibles : Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Tableau.Test sur ligne unique Case à cocher Choix Date, adresse E-mail Entier,Date/heure Objet Texte sur ligne unique Oui/Non Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : objet `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne
productOrderItem.product.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.quantity	Nombre d’éléments de produit achetés. Type de données : nombre
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
productOrderItem.state	État de la commande de l’élément de produit associé. Type de données : chaîne
productOrderItem.version	Version de la commande. Type de données : chaîne
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
État	État actuel de la commande. Type de données : chaîne
version	Version de la commande. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Demande cURL

L’exemple de code suivant demande une commande client existante.

curl -X GET "https://servicenow-instance/api/sn_ind_tmt_orm/productorder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"

Corps de la réponse.

{
  "id": "8d75939453126010a795ddeeff7b126a",
  "ponr": "false",
  "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
  "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
  "requestedStartDate": "2020-05-03T08:13:59.000Z",
  "channel": [
    {
      "id": "1",
      "name": "Agent Assist"
    }
  ],
  "note": [
    {
      "author": "System Administrator",
      "date": "2021-02-25T14:22:07.000Z",
      "text": "This is a TMF product order illustration no 2"
    },
    {
      "author": "System Administrator",
      "date": "2021-02-25T14:22:06.000Z",
      "text": "This is a TMF product order illustration"
    }
  ],

  "productOrderItem": [
    {
      "id": "POI130",
      "ponr": "false",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        },
        {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "INR",
              "value": 0
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "valueType": "Choice",
            "value": "Base",
            "previousValue": ""
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "4175939453126010a795ddeeff7b127d",
            "name": "John Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          },
          {
            "id": "c175939453126010a795ddeeff7b127c",
            "name": "Joe Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "state": "in_progress",
      "version": "1",
      "@type": "ProductOrderItem"
    },
    {
    "id": "POI100",
    "ponr": "false",
    "quantity": 1,
    "action": "add",
    "itemPrice": [
      {
        "priceType": "recurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "INR",
            "value": 0
          }
        }
      },
      {
        "priceType": "nonRecurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "INR",
            "value": 0
          }
        }
      }
    ],
    "product": {
      "@type": "Product",
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "@type": "ProductSpecificationRef"
      }
    },
    "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering"
    },
    "productOrderItemRelationship": [
      {
        "id": "POI130",
        "relationshipType": "HasChild"
      },
      {
        "id": "POI120",
        "relationshipType": "HasChild"
      },
      {
        "id": "POI110",
        "relationshipType": "HasChild"
      }
    ],
    "state": "in_progress",
    "version": "1",
    "@type": "ProductOrderItem"
  },
  {
    "id": "POI120",
    "ponr": "false",
    "quantity": 1,
    "action": "add",
    "itemPrice": [
      {
        "priceType": "recurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        },
        {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "INR",
              "value": 0
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "Choice",
            "value": "Physical",
            "previousValue": ""
          },
          {
            "name": "WAN Optimization",
            "valueType": "Choice",
            "value": "Advance",
            "previousValue": ""
          },
          {
            "name": "Routing",
            "valueType": "Choice",
            "value": "Premium",
            "previousValue": ""
          },
          {
            "name": "CPE Model",
            "valueType": "Choice",
            "value": "ASR",
            "previousValue": ""
           }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "@type": "ProductSpecificationRef"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "state": "in_progress",
      "version": "1",
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI110",
      "ponr": "false",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
            "price": {
              "taxIncludedAmount": {
                "unit": "INR",
                "value": 0
              }
            }
          },
          {
          "priceType": "nonRecurring",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 5
            }
          }
        }
      ],
      "product": {
      "@type": "Product",
      "productCharacteristic": [
        {
          "name": "Tenancy",
          "valueType": "Choice",
          "value": "Base (10 site)",
          "previousValue": ""
        }
      ],
      "productSpecification": {
        "id": "216663aa53702010cd6dddeeff7b12b5",
        "name": "SD-WAN Controller",
        "@type": "ProductSpecificationRef"
      },
      "place": {
        "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
        "@type": "Place"
      }
    },
    "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering"
    },
    "productOrderItemRelationship": [
      {
        "id": "POI100",
        "relationshipType": "HasParent"
      }
    ],
    "state": "in_progress",
    "version": "1",
    "@type": "ProductOrderItem"
  }
],
"relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}

API ouverte de commande de produit : PATCH /sn_ind_tmt_orm/order/productOrder/{id}

Met à jour la commande client spécifiée.

Format d'URL

URL par défaut : /api/sn_ind_tmt_orm/order/productOrder/{id}

Paramètres de demande pris en charge

Tableau 25. Paramètres de chemin d'accès
Nom	Description
id	Sys_id de la commande de client à mettre à jour. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]

Tableau 26. Paramètres de requête
Nom	Description
Aucun

Tableau 27. Paramètres du corps de la demande (JSON)
Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
channel.id	Requis si le channel paramètre est utilisé. Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne Table : dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Stocké dans : Le champ Canal de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
channel.name	Nom du canal à utiliser pour vendre les produits associés. Les noms de canaux possibles sont définis dans l’onglet Liste de choix de l’entrée du dictionnaire des canaux de la table sn_ind_tmt_orm_order. Type de données : chaîne Valeur par défaut : chaîne vide
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Si l’action pour les éléments de ligne de commande est `suspendre` ou `reprendre`, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table sn_ind_tmt_orm_order.
externalId	Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : Le champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
orderCurrency	Code de devise pour la commande et les éléments de ligne de bon de commande. La mise à jour du code de devise d’une commande existante n’est pas prise en charge. Si vous fournissez une valeur autre que le code de devise déjà associé à la commande, la mise à jour est rejetée. Type de données : chaîne
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item
produitÉlémentCommande.action	Requis si le productOrderItem paramètre est utilisé. Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles : ajouter changement supprimer Aucun changement reprendre suspendre Type de données : chaîne Stocké dans : Le champ d’action de la table sn_ind_tmt_orm_order_line_item. Par défaut : ajouter
productOrderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Si l’action de l’élément est `suspendre` ou `reprendre`, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.externalProductInventory	Liste des ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée.
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : le champ external_inventory_id de la table sn_ind_tmt_orm_order_line_item et le champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory.
productOrderItem.id	Requis si le productOrderItem paramètre est utilisé. Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order_line_item. Longueur maximale : 40 Valeur par défaut : chaîne vide
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Stocké dans : sn_ind_tmt_orm_order Valeur par défaut : chaîne vide
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }` Stocké dans : sn_ind_tmt_orm_order_line_item Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }` Stocké dans : sn_ind_tmt_orm_order_line_item
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item.
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.valeur	Prix du produit, taxes comprises. Type de données : nombre Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
produitCommandeÉlément.produit	Requis si productOrderItem.action est modifier ou supprimer. Description des détails d’instance du produit acheté par le client. Type de données : objet `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Requis si productOrderItem.action est modifier ou supprimer. Identificateur unique du produit vendu. Situé dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Type de données : chaîne Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.product.place.id	Requis si le productOrderItem.product.place paramètre est utilisé. Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne Stocké dans : champ Emplacement de la table sn_ind_tmt_orm_order_line_item. Valeur par défaut : chaîne vide
productOrderItem.product.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne Stocké dans : Le champ des caractéristiques de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : Le previous_characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : Le champ characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
productItemOrder.product.productCharacteristic.valueType	Type de valeur caractéristique. Type de données : chaîne Valeurs possibles : tableau.date tableau.date/heure tableau.décimal array.integer tableau.objet tableau.test sur ligne unique case à cocher choix date, adresse E-mail entier,date/heure objet Texte sur ligne unique oui/non
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Remarque : Les ordres de changement (productOrderItem.action est `un changement`) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. La valeur de cette propriété système détermine le mode de traitement de la commande si l’inventaire des produits est une version différente de celle indiquée dans la commande. Lorsque cette propriété système est définie sur vrai (par défaut), l’inventaire de produits est automatiquement mis à niveau vers la version de la commande en modifiant la spécification du produit référencé. Cela permet à la commande d’être traitée avec succès. Lorsque cette propriété système est définie sur faux, si l’inventaire des produits est une version différente de celle indiquée dans la commande, la commande échoue en raison d’une incompatibilité de version. Type de données : objet `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Requis si le productOrderItem.product.productSpecification paramètre est utilisé. Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
élémentcommandeproduit.produit.spécificationsproduit.versioninterne	Version de la spécification du produit. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
élémentcommandeproduit.produit.spécifications.version	External_version de la spécification du produit. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne Stocké dans : Le champ E-mail de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne Stocké dans : Le champ first_name de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne Stocké dans : Le champ sys_id de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Stocké dans : Le champ lastName de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.FêteConnexe.téléphone	Numéro de téléphone professionnel du contact. Type de données : chaîne Stocké dans : Le champ business_phone de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `Produit`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Requis si le productOrderItem.productOffering paramètre est utilisé. Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
produitCommandeÉlément.produitÉlémentCommande.quantité	Nombre des éléments associés à commander. Type de données : nombre Stocké dans : champ de quantité du sn_ind_tmt_orm_order. Valeur par défaut : nul
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Requis si le productOrderItem.productOrderItemRelationship paramètre est utilisé. Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : Le champ parent_line_item de thebsn_ind_tmt_orm_order_line_item table. Valeur par défaut : chaîne vide
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
productOrderItem.quantity	Nombre d’éléments commandés. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
productOrderItem.revisionOperation	Type de mise à jour à effectuer sur l’élément de ligne. Si cette valeur est vide, l’élément de ligne existant est mis à jour ou un nouvel élément de ligne est ajouté s’il n’existe pas déjà. Si cette valeur est `annulée`, l’élément de ligne est annulé. Type de données : chaîne Valeur par défaut : chaîne vide
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

En-têtes

Tableau 28. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 29. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 30. Codes d'état
Code d'état	Description
201	Réussi. En cas de problème avec les caractéristiques ou les informations d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé : `Les caractéristiques suivantes de l’élément de commande n’existent pas : examinez les <characteristic.name de spécification> et corrigez la caractéristique et l’option de caractéristique dans l’élément de ligne de commande avant d’approuver la commande.` `Caractéristique de l’élément de commande : <characteristic.name> avec une valeur caractéristique : <characteristic.value>n’est pas valide. Corrigez les valeurs caractéristiques avant d’approuver la commande.`
400	Demande incorrecte. Peut être l’une des raisons suivantes : `Charge utile non valide : corps de la demande manquant : la` charge utile n’a pas été transmise dans le corps de la demande. `Charge utile non valide : productOrderItem est manquant :` objet d’élément de ligne de commande de produit ou JSON manquant. `Charge utile non valide : l’ID productOrderItem est manquant :` le id paramètre est manquant dans l’élément de ligne de commande de produit de la charge utile. `Charge utile non valide : l’action productOrderItem est manquante :` le action paramètre est manquant dans l’élément de ligne de commande de produit de la charge utile. `Charge utile non valide : productOrderItem productOffering est manquant` : l’objet d’offre de produit ou le JSON est manquant dans l’élément de ligne de commande de produit dans la charge utile. `Charge utile non valide : l’ID productOffering est manquant :`id le paramètre est manquant dans l’élément de ligne de commande de produit de l’objet d’offre de produit dans la charge utile. `Charge utile non valide : L’offre de produit n’existe pas :` l’offre de produit dans l’élément de ligne de commande du produit n’est pas valide. `Charge utile non valide : produit productOrderItem manquant` : l’objet produit ou le JSON dans l’élément de ligne de commande du produit est manquant dans la charge utile. `Charge utile non valide : product Specification est manquant` : l’objet de spécification de produit ou le JSON dans l’élément de ligne de commande de produit est manquant dans la charge utile. `Charge utile non valide : l’ID de spécification produit est manquant :` le id paramètre de l’élément de ligne de commande de produit de l’objet de spécification de produit est manquant dans la charge utile. `Charge utile non valide : la spécification du produit n’existe pas :` la spécification du produit dans l’élément de ligne de commande du produit n’est pas valide. `Charge utile non valide : L’inventaire de produits n’existe pas` - Dans un ordre de changement (action = changement), la quantité d’un élément est supérieure à ce qui est en stock. `Charge utile non valide : L’ID d’inventaire des produits est manquant` : dans un ordre de changement, il manque dans product.id la charge utile. `Charge utile non valide : le produit vendu est inactif :` dans un ordre de changement, un produit spécifié dans la charge utile est inactif. `Charge utile non valide : relatedParty est manquant :` l’objet de partie connexe est manquant dans la charge utile. `Le compte client ou le consommateur est manquant` : le client ou l’objet consommateur tiers connexe est manquant dans la charge utile. `Charge utile non valide : le consommateur n’existe pas :` le consommateur tiers associé spécifié n’existe pas dans l’instance ServiceNow . `Charge utile non valide : Le compte client n’existe pas` : le client tiers associé spécifié n’existe pas dans l’instance ServiceNow . `Charge utile non valide : Échec` de la création de la commande - Impossible de créer la commande demandée. `Révision en cours de la devise de commande non prise en charge` : le orderCurrency paramètre ne peut pas être mis à jour une fois la commande créée. `Cette commande doit encore être créée dans la table de commande client. Veuillez vérifier la file d’attente entrante pour plus d’informations.` – L’ID de commande fourni n’est pas dans la table de commande client. `La demande de correctif ne peut pas être effectuée car le type d’exécution de la commande n’est pas « livrer ».` – La demande de correctif a été effectuée sur une commande dont le type d’exécution n’est pas livré.

Paramètres de corps de réponse (JSON)


Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne
channel.name	Nom du canal à utiliser pour vendre les produits associés. Type de données : chaîne
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne
externalId	Identificateur externe du bon de commande, tel qu’un numéro de bon de commande. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de produit. Type de données : chaîne
id	Sys_id de la commande client mise à jour pour cette demande. Type de données : chaîne
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]`
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
orderCurrency	Code de devise pour la commande et les éléments de ligne de bon de commande. Type de données : chaîne
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
produitÉlémentCommande.action	Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
productOrderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne
productOrderItem.externalProductInventory	Liste des ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée.
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire de produits. Type de données : chaîne
productOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
produitCommandeÉlément.élémentPrix.prix.taxIncludeMontant.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne
produitCommandeÉlément.élémentPrix.prix.taxIncludeMontant.valeur	Prix du produit, taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
produitCommandeÉlément.produit	Description des détails d’instance du produit acheté par le client. Type de données : objet `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	Identificateur unique du produit vendu. Situé dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Type de données : chaîne
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalId	Version initiale de la spécification du produit. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
élémentcommandeproduit.produit.spécificationsproduit.versioninterne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
élémentcommandeproduit.produit.spécifications.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne
productOrderItem.product.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `Produit`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalId	Version initiale de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Type de données : chaîne
productOrderItem.quantity	Nombre des éléments associés à commander. Type de données : nombre
productOrderItem.state	État actuel de l’élément de commande de produit. Type de données : chaîne
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.type	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
État	État actuel de la commande. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Demande cURL

Cet exemple met à jour le canal d’une commande de produit.

curl -X PATCH "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "channel": [
    {
      "id": "1",
      "name": "Agent Assist"
    }
  ]
}

Corps de la réponse.

{
   "id": "8d75939453126010a795ddeeff7b126a",
   "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
   "expectedCompletionDate": "2021-05-02T08:13:59.000Z",
   "requestedCompletionDate": "2021-05-02T08:13:59.000Z",
   "requestedStartDate": "2020-05-03T08:13:59.000Z",
   "externalId": "PO-456",
   "orderCurrency": "USD",
   "channel": [
      {
         "id": "1",
         "name": "Agent Assist"
      }
   ],
   "note": [
      {
         "author": "System Administrator",
         "date": "2021-02-25T14:22:07.000Z",
         "text": "This is a TMF product order illustration no 2"
      },
      {
         "author": "System Administrator",
         "date": "2021-02-25T14:22:06.000Z",
         "text": "This is a TMF product order illustration"
      }
   ],
   "productOrderItem": [
      {
         "id": "POI130",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 20
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "Security Type",
                  "valueType": "Choice",
                  "value": "Base",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247",
               "@type": "ProductSpecificationRef"
            },
            "relatedParty": [
               {
                  "id": "4175939453126010a795ddeeff7b127d",
                  "name": "John Smith",
                  "email": "abc2@example.com",
                  "phone": "32456768",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               },
               {
                  "id": "c175939453126010a795ddeeff7b127c",
                  "name": "Joe Doe",
                  "email": "abc@example.com",
                  "phone": "1234567890",
                  "@type": "RelatedParty",
                  "@referredType": "OrderLineItemContact"
               }
            ]
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI100",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productSpecification": {
               "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
               "name": "SD-WAN Service Package",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
               "@type": "ProductSpecificationRef"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI130",
               "relationshipType": "HasChild"
            },
            {
               "id": "POI120",
               "relationshipType": "HasChild"
            },
            {
               "id": "POI110",
               "relationshipType": "HasChild"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI120",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason": "adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 20
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "CPE Type",
                  "valueType": "Choice",
                  "value": "Physical",
                  "previousValue": ""
               },
               {
                  "name": "WAN Optimization",
                  "valueType": "Choice",
                  "value": "Advance",
                  "previousValue": ""
               },
               {
                  "name": "Routing",
                  "valueType": "Choice",
                  "value": "Premium",
                  "previousValue": ""
               },
               {
                  "name": "CPE Model",
                  "valueType": "Choice",
                  "value": "ASR",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202",
               "@type": "ProductSpecificationRef"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "69017a0f536520103b6bddeeff7b127d"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      },
      {
         "id": "POI110",
         "ponr": "false",
         "quantity": 1,
         "action": "add",
         "actionReason":"adding service package OLI",
         "itemPrice": [
            {
               "priceType": "recurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "INR",
                     "value": 0
                  }
               }
            },
            {
               "priceType": "nonRecurring",
               "price": {
                  "taxIncludedAmount": {
                     "unit": "USD",
                     "value": 5
                  }
               }
            }
         ],
         "product": {
            "@type": "Product",
            "productCharacteristic": [
               {
                  "name": "Tenancy",
                  "valueType": "Choice",
                  "value": "Base (10 site)",
                  "previousValue": ""
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5",
               "@type": "ProductSpecificationRef"
            },
            "place": {
               "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
               "@type": "Place"
            }
         },
         "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "version": "v1",
            "internalId": "69017a0f536520103b6bddeeff7b127d",
            "internalVersion": "1"
         },
         "productOrderItemRelationship": [
            {
               "id": "POI100",
               "relationshipType": "HasParent"
            }
         ],
         "state": "in_progress",
         "version": "1",
         "@type": "ProductOrderItem"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "state": "in_progress",
   "@type": "ProductOrder"
}

API ouverte de commande de produit : PATCH /sn_ind_tmt_orm/productorder/{id}

Met à jour la commande client spécifiée.

Important :

À partir de la mise en Tokyo production, ce point de terminaison est obsolète. La nouvelle version de ce point de terminaison est API ouverte de commande de produit : PATCH /sn_ind_tmt_orm/order/productOrder/{id}.

Format d'URL

URL par défaut : /api/sn_ind_tmt_orm/productorder/{id}

Paramètres de demande pris en charge

Tableau 31. Paramètres de chemin d'accès
Nom	Description
id	Sys_id de la commande de client à mettre à jour. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]

Tableau 32. Paramètres de requête
Nom	Description
Aucun

Tableau 33. Paramètres du corps de la demande (JSON)
Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
channel.id	Requis si le channel paramètre est utilisé. Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne Table : dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Stocké dans : Le champ Canal de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
channel.name	Nom du canal à utiliser pour vendre les produits associés. Les noms de canaux possibles sont définis dans l’onglet Liste de choix de l’entrée du dictionnaire des canaux de la table sn_ind_tmt_orm_order. Type de données : chaîne Valeur par défaut : chaîne vide
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Si l’action pour les éléments de ligne de commande est `suspendre` ou `reprendre`, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table sn_ind_tmt_orm_order.
externalId	Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : Le champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
orderCurrency	Code de devise pour la commande et les éléments de ligne de bon de commande. La mise à jour du code de devise d’une commande existante n’est pas prise en charge. Si vous fournissez une valeur autre que le code de devise déjà associé à la commande, la mise à jour est rejetée. Type de données : chaîne
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item
produitÉlémentCommande.action	Requis si le productOrderItem paramètre est utilisé. Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles : ajouter changement supprimer Aucun changement reprendre suspendre Type de données : chaîne Stocké dans : Le champ d’action de la table sn_ind_tmt_orm_order_line_item. Par défaut : ajouter
productOrderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Si l’action de l’élément est `suspendre` ou `reprendre`, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.externalProductInventory	Liste des ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée.
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : le champ external_inventory_id de la table sn_ind_tmt_orm_order_line_item et le champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory.
productOrderItem.id	Requis si le productOrderItem paramètre est utilisé. Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order_line_item. Longueur maximale : 40 Valeur par défaut : chaîne vide
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Stocké dans : sn_ind_tmt_orm_order Valeur par défaut : chaîne vide
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }` Stocké dans : sn_ind_tmt_orm_order_line_item Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }` Stocké dans : sn_ind_tmt_orm_order_line_item
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item.
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.valeur	Prix du produit, taxes comprises. Type de données : nombre Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
produitCommandeÉlément.produit	Requis si productOrderItem.action est modifier ou supprimer. Description des détails d’instance du produit acheté par le client. Type de données : objet `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Requis si productOrderItem.action est modifier ou supprimer. Identificateur unique du produit vendu. Situé dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Type de données : chaîne Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.product.place.id	Requis si le productOrderItem.product.place paramètre est utilisé. Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne Stocké dans : champ Emplacement de la table sn_ind_tmt_orm_order_line_item. Valeur par défaut : chaîne vide
productOrderItem.product.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne Stocké dans : Le champ des caractéristiques de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : Le previous_characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : Le champ characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
productItemOrder.product.productCharacteristic.valueType	Type de valeur caractéristique. Type de données : chaîne Valeurs possibles : tableau.date tableau.date/heure tableau.décimal array.integer tableau.objet tableau.test sur ligne unique case à cocher choix date, adresse E-mail entier,date/heure objet Texte sur ligne unique oui/non
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Remarque : Les ordres de changement (productOrderItem.action est `un changement`) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. La valeur de cette propriété système détermine le mode de traitement de la commande si l’inventaire des produits est une version différente de celle indiquée dans la commande. Lorsque cette propriété système est définie sur vrai (par défaut), l’inventaire de produits est automatiquement mis à niveau vers la version de la commande en modifiant la spécification du produit référencé. Cela permet à la commande d’être traitée avec succès. Lorsque cette propriété système est définie sur faux, si l’inventaire des produits est une version différente de celle indiquée dans la commande, la commande échoue en raison d’une incompatibilité de version. Type de données : objet `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Requis si le productOrderItem.product.productSpecification paramètre est utilisé. Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
élémentcommandeproduit.produit.spécificationsproduit.versioninterne	Version de la spécification du produit. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
élémentcommandeproduit.produit.spécifications.version	External_version de la spécification du produit. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne Stocké dans : Le champ E-mail de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne Stocké dans : Le champ first_name de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne Stocké dans : Le champ sys_id de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Stocké dans : Le champ lastName de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.FêteConnexe.téléphone	Numéro de téléphone professionnel du contact. Type de données : chaîne Stocké dans : Le champ business_phone de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `Produit`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Requis si le productOrderItem.productOffering paramètre est utilisé. Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
produitCommandeÉlément.produitÉlémentCommande.quantité	Nombre des éléments associés à commander. Type de données : nombre Stocké dans : champ de quantité du sn_ind_tmt_orm_order. Valeur par défaut : nul
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Requis si le productOrderItem.productOrderItemRelationship paramètre est utilisé. Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : Le champ parent_line_item de thebsn_ind_tmt_orm_order_line_item table. Valeur par défaut : chaîne vide
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
productOrderItem.quantity	Nombre d’éléments commandés. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
productOrderItem.revisionOperation	Type de mise à jour à effectuer sur l’élément de ligne. Si cette valeur est vide, l’élément de ligne existant est mis à jour ou un nouvel élément de ligne est ajouté s’il n’existe pas déjà. Si cette valeur est `annulée`, l’élément de ligne est annulé. Type de données : chaîne Valeur par défaut : chaîne vide
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

En-têtes

Tableau 34. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 35. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 36. Codes d'état
Code d'état	Description
201	Réussi. En cas de problème avec les caractéristiques ou les informations d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé : `Les caractéristiques suivantes de l’élément de commande n’existent pas : examinez les <characteristic.name de spécification> et corrigez la caractéristique et l’option de caractéristique dans l’élément de ligne de commande avant d’approuver la commande.` `Caractéristique de l’élément de commande : <characteristic.name> avec une valeur caractéristique : <characteristic.value>n’est pas valide. Corrigez les valeurs caractéristiques avant d’approuver la commande.`
400	Demande incorrecte. Peut être l’une des raisons suivantes : `Charge utile non valide : corps de la demande manquant : la` charge utile n’a pas été transmise dans le corps de la demande. `Charge utile non valide : productOrderItem est manquant :` objet d’élément de ligne de commande de produit ou JSON manquant. `Charge utile non valide : l’ID productOrderItem est manquant :` le id paramètre est manquant dans l’élément de ligne de commande de produit de la charge utile. `Charge utile non valide : l’action productOrderItem est manquante :` le action paramètre est manquant dans l’élément de ligne de commande de produit de la charge utile. `Charge utile non valide : productOrderItem productOffering est manquant` : l’objet d’offre de produit ou le JSON est manquant dans l’élément de ligne de commande de produit dans la charge utile. `Charge utile non valide : l’ID productOffering est manquant :`id le paramètre est manquant dans l’élément de ligne de commande de produit de l’objet d’offre de produit dans la charge utile. `Charge utile non valide : L’offre de produit n’existe pas :` l’offre de produit dans l’élément de ligne de commande du produit n’est pas valide. `Charge utile non valide : produit productOrderItem manquant` : l’objet produit ou le JSON dans l’élément de ligne de commande du produit est manquant dans la charge utile. `Charge utile non valide : product Specification est manquant` : l’objet de spécification de produit ou le JSON dans l’élément de ligne de commande de produit est manquant dans la charge utile. `Charge utile non valide : l’ID de spécification produit est manquant :` le id paramètre de l’élément de ligne de commande de produit de l’objet de spécification de produit est manquant dans la charge utile. `Charge utile non valide : la spécification du produit n’existe pas :` la spécification du produit dans l’élément de ligne de commande du produit n’est pas valide. `Charge utile non valide : L’inventaire de produits n’existe pas` - Dans un ordre de changement (action = changement), la quantité d’un élément est supérieure à ce qui est en stock. `Charge utile non valide : L’ID d’inventaire des produits est manquant` : dans un ordre de changement, il manque dans product.id la charge utile. `Charge utile non valide : le produit vendu est inactif :` dans un ordre de changement, un produit spécifié dans la charge utile est inactif. `Charge utile non valide : relatedParty est manquant :` l’objet de partie connexe est manquant dans la charge utile. `Charge utile non valide : le compte client ou le consommateur est manquant` : le client ou l’objet consommateur tiers connexe est manquant dans la charge utile. `Charge utile non valide : le consommateur n’existe pas :` le consommateur tiers associé spécifié n’existe pas dans l’instance ServiceNow . `Charge utile non valide : Le compte client n’existe pas` : le client tiers associé spécifié n’existe pas dans l’instance ServiceNow . `Charge utile non valide : Échec` de la création de la commande - Impossible de créer la commande demandée. `Charge utile non valide : cette commande doit encore être créée dans la table de commande client. Veuillez vérifier la file d’attente entrante pour plus d’informations.` - La demande de correctif a été effectuée pour une commande qui n’est pas encore dans la table des commandes client. L’ordre se trouve dans la table File d’attente entrante [sn_tmt_core_inbound_queue] en attente du planificateur pour sélectionner l’enregistrement à traiter. `Charge utile non valide : la demande de correctif ne peut pas être effectuée car le type d’exécution de la commande n’est pas « livrer ».` - La demande de correctif a été effectuée pour une commande dont le type d’exécution n’est pas deliver défini.

Paramètres de corps de réponse (JSON)


Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne
channel.name	Nom du canal à utiliser pour vendre les produits associés. Type de données : chaîne
id	Sys_id de la commande client mise à jour pour cette demande. Type de données : chaîne
externalId	Identificateur externe du bon de commande, tel qu’un numéro de bon de commande. Type de données : chaîne
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]`
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
produitÉlémentCommande.action	Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
productOrderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
produitCommandeÉlément.élémentPrix.prix.taxIncludeMontant.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne
produitCommandeÉlément.élémentPrix.prix.taxIncludeMontant.valeur	Prix du produit, taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
produitCommandeÉlément.produit	Description des détails d’instance du produit acheté par le client. Type de données : objet `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	Identificateur unique du produit vendu. Situé dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Type de données : chaîne
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Type de données : objet `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne
productOrderItem.product.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Type de données : chaîne
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `Produit`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Type de données : chaîne
productOrderItem.quantity	Nombre des éléments associés à commander. Type de données : nombre
productOrderItem.state	État actuel de l’élément de commande de produit. Type de données : chaîne
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.type	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
État	État actuel de la commande. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Demande cURL

L’exemple de code suivant met à jour le canal d’une commande client.

curl -X PATCH "https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder/6be0a925c3a220103e2e73ce3640ddfe" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "channel": [
    {
      "id": "1",
      "name": "Agent Assist"
    }
  ]
}

Corps de la réponse.

{
    "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
    "requestedStartDate": "2020-05-03T08:13:59.506Z",
    "externalId": "PO-456",
    "channel": [
        {
            "id": "1",
            "name": "Agent Assist"
        }
    ],
    "note": [
        {
            "text": "This is a TMF product order illustration"
        },
        {
            "text": "This is a TMF product order illustration no 2"
        }
    ],
    "productOrderItem": [
        {
            "id": "POI100",
            "quantity": 1,
            "action": "change",
            "actionReason":"adding service package OLI",
            "product": {
                "id": "fa6d13f45b5620102dff5e92dc81c77f",
                "@type": "Product",
                "productSpecification": {
                    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
                    "name": "SD-WAN Service Package",
                    "@type": "ProductSpecificationRef"
                },
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI120",
                    "relationshipType": "HasChild"
                },
                {
                    "id": "POI130",
                    "relationshipType": "HasChild"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        },
        {
            "id": "POI120",
            "quantity": 1,
            "action": "change",
            "actionReason":"adding service package OLI",
            "itemPrice": [
                {
                    "priceType": "recurring",
                    "recurringChargePeriod": "month",
                    "price": {
                        "taxIncludedAmount": {
                            "unit": "USD",
                            "value": 20
                        }
                    }
                }
            ],
            "product": {
                "id": "766d13f45b5620102dff5e92dc81c78a",
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "WAN Optimization"
                        "valueType": "Choice",
                        "value": "Base",
                        "previousValue": "Advance"
                    }
                ],
                "productSpecification": {
                    "id": "39b627aa53702010cd6dddeeff7b1202",
                    "name": "SD-WAN Edge Device",
                    "@type": "ProductSpecificationRef"
                },
                "relatedParty": [
                    {
                        "id": "51670151c35420105252716b7d40ddfe",
                        "firstName": "Joe",
                        "lastName": "Doe",
                        "email": "abc@example.com",
                        "phone": "1234567890",
                        "@type": "RelatedParty",
                        "@referredType": "OrderLineItemContact"
                    }
                ],
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI100",
                    "relationshipType": "HasParent"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        },
        {
            "id": "POI130",
            "quantity": 1,
            "action": "add",
            "actionReason":"adding service package OLI",
            "itemPrice": [
                {
                    "priceType": "recurring",
                    "recurringChargePeriod": "month",
                    "price": {
                        "taxIncludedAmount": {
                            "unit": "USD",
                            "value": 20
                        }
                    }
                }
            ],
            "product": {
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "Security Type",
                        "valueType": "Choice",
                        "value": "Base",
                        "previousValue": "Advance"
                    }
                ],
                "productSpecification": {
                    "id": "a6514bd3534560102f18ddeeff7b1247",
                    "name": "SD-WAN Security",
                    "@type": "ProductSpecificationRef"
                },
                "relatedParty": [
                    {
                        "id": "51670151c35420105252716b7d40ddfe",
                        "firstName": "Joe",
                        "lastName": "Doe",
                        "email": "abc@example.com",
                        "phone": "1234567890",
                        "@type": "RelatedParty",
                        "@referredType": "OrderLineItemContact"
                    }
                ],
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI100",
                    "relationshipType": "HasParent"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        }
    ],
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "@type": "ProductOrder",
    "id": "6be0a925c3a220103e2e73ce3640ddfe",
    "state": "in_progress"
}

API ouverte de commande de produit : POST /sn_ind_tmt_orm/cancelproductorder

Annule la commande client spécifiée.

Format d'URL

URL par défaut : /api/sn_ind_tmt_orm/cancelproductorder

Paramètres de demande pris en charge

Tableau 37. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 38. Paramètres de requête
Nom	Description
Aucun

Tableau 39. Paramètres du corps de la demande (JSON)
Nom	Description
motif d’annulation	Motif de l’annulation. Type de données : chaîne Valeur par défaut : chaîne vide
commande de produit	Contient des données sur la commande du produit. Type de données : objet `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.id	Requis. Sys_id de la commande du client à annuler. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
productOrder.href	URL de la commande client à annuler. Type de données : chaîne Valeur par défaut : chaîne vide
productOrder.@referredType	La valeur de ce paramètre doit être `ProductOrder`. Type de données : chaîne Valeur par défaut : chaîne vide
requestedCancellationDate	Date d’annulation de la commande. Type de données : chaîne Valeur par défaut : chaîne vide
@type	La valeur de ce paramètre doit être `CancelProductOrder`. Type de données : chaîne Valeur par défaut : chaîne vide

En-têtes

Tableau 40. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 41. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 42. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Peut être l’une des raisons suivantes : Charge utile vide. Charge utile non valide. Champ obligatoire manquant : <nom de champ>. ID de commande non valide. ID de commande non valide : `cette commande doit encore être créée dans la table de commande client`. La demande d’annulation a été faite pour une commande qui n’a pas encore été créée. L’ordre se trouve dans la table File d’attente entrante [sn_tmt_core_inbound_queue] en attente que le planificateur récupère l’enregistrement.

Paramètres de corps de réponse (JSON)


Nom	Description
motif d’annulation	Motif de l’annulation. Type de données : chaîne
href	URL de la commande annulée. Type de données : chaîne
id	Sys_id de la commande annulée. Type de données : chaîne
commande de produit	Données sur la commande du produit. Type de données : objet `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.id	Sys_id de la commande annulée. Type de données : chaîne
productOrder.href	URL de la commande annulée. Type de données : chaîne
productOrder.@referredType	La valeur de ce paramètre est `ProductOrder`. Type de données : chaîne
requestedCancellationDate	Date d’annulation de la commande. Type de données : chaîne
État	État de l’annulation. Si la demande d’annulation a été traitée avec succès (code d’état 201), la valeur de ce paramètre est `terminée`. Type de données : chaîne
@type	La valeur de ce paramètre est `CancelProductOrder`. Type de données : chaîne

Demande cURL

L’exemple de code suivant annule une commande client.

curl -X POST "https://instance.servicenow.com/api/sn_ind_tmt_orm/cancelproductorder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
    "cancellationReason": "Duplicate order",
    "requestedCancellationDate": "2019-04-30T12:56:21.931Z",
    "productOrder": {
        "id": "163ee2805358811032a4ddeeff7b122d",
        "href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
        "@referredType": "ProductOrder"
    },
    "@type": "CancelProductorder"
}

{
    "id": "163ee2805358811032a4ddeeff7b122d",
    "href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
    "cancellationReason": "Duplicate order",
    "requestedCancellationDate": "2019-04-30T12:56:21.931Z",
    "@type": "CancelProductorder",
    "productOrder": {
        "id": "163ee2805358811032a4ddeeff7b122d",
        "href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
        "@referredType": "ProductOrder"
    },
    "state": "done"
}

API ouverte de commande de produit : POST /sn_ind_tmt_orm/order/productOrder

Crée la commande client et les éléments de ligne de commande client spécifiés.

Une fois traités, les enregistrements sont créés dans les tables suivantes :

Commande de clients [sn_ind_tmt_orm_order]
Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
Contact d’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]
Éléments liés à la ligne de commande [sn_ind_tmt_orm_order_line_related_items]

Format d'URL

URL par défaut : /api/sn_ind_tmt_orm/order/productOrder

Paramètres de demande pris en charge

Tableau 43. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 44. Paramètres de requête
Nom	Description
Mode	Permet un traitement asynchrone des commandes. En d’autres termes, la commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] pour être créée. Si elle n’est pas incluse, la commande est traitée de manière synchrone. Valeur valide : asynchrone Type de données : chaîne

Tableau 45. Paramètres du corps de la demande (JSON)
Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
channel.id	Requis. Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs de l’ID de canal se trouvent dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne Stocké dans : Le champ Canal de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
channel.name	Nom du canal à utiliser pour vendre les produits associés. Les noms de canaux possibles sont définis dans l’onglet Liste de choix de l’entrée du dictionnaire des canaux de la table sn_ind_tmt_orm_order. Type de données : chaîne Valeur par défaut : chaîne vide
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table sn_ind_tmt_orm_order.
externalId	Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
remarque	Remarques supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
note.text	Requis. Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : Le champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
orderCurrency	Requis. Code de devise pour la commande et les éléments de ligne de bon de commande. La devise doit être la même pour tous les éléments de la commande et des éléments de ligne de commande, sinon une erreur est renvoyée et la commande n’est pas créée. Une fois qu’une commande est créée, son code de devise ne peut pas être modifié. Type de données : chaîne
productOrderItem	Requis. Éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
produitÉlémentCommande.action	Requis. Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles : ajouter changement supprimer Aucun changement reprendre suspendre Type de données : chaîne Stocké dans : Le champ d’action de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
productOrderItem.actionReason	Facultatif. Description du motif de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
productOrderItem.externalProductInventory	ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : Champ external_inventory_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] et champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory.
productOrderItem.id	Requis. Identificateur unique de l’élément de ligne. Type de données : chaîne Stocké dans : Le champ external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Longueur maximale : 40 Valeur par défaut : chaîne vide
productItemItem.itemPrice	Prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Stocké dans : sn_ind_tmt_orm_order Valeur par défaut : chaîne vide
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.unité	Code de devise dans lequel le prix est exprimé. Type de données : chaîne Stocké dans : champ mrc ou nrc de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.valeur	Prix du produit, taxes comprises. Type de données : nombre Stocké dans : champ mrc ou nrc de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
productOrderItem.itemPrice.priceType	Spécifie si le prix de l’élément est récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
produitCommandeÉlément.produit	Requis si productOrderItem.action est modifier ou supprimer. Détails d’instance du produit acheté par le client. Type de données : objet `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
productOrderItem.product.id	Requis si productOrderItem.action est modifier ou supprimer. Identificateur unique du produit vendu. Type de données : chaîne Valeur par défaut : chaîne vide Table : dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory].
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
productOrderItem.product.place.id	Requis. Sys_id de l’enregistrement de l’emplacement associé. Type de données : chaîne Table : Emplacement [cmn_location] Stocké dans : champ Emplacement de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
productOrderItem.product.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Caractéristiques du produit associé. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Type de données : chaîne Table : Caractéristique [sn_prd_pm_characteristic] Stocké dans : Le champ des caractéristiques de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : champ previous_characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : Le champ characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
productItemOrder.product.productCharacteristic.valueType	Type de valeur caractéristique. Valeurs possibles : Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Tableau.Test sur ligne unique Case à cocher Choix Date, adresse E-mail Entier,Date/heure Objet Texte sur ligne unique Oui/Non Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Facultatif. Description de la spécification du produit associée au produit. Remarque : Les ordres de changement (productOrderItem.action est `un changement`) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. La valeur de cette propriété système détermine le mode de traitement de la commande si l’inventaire des produits est une version différente de celle indiquée dans la commande. Lorsque cette propriété système est définie sur vrai (par défaut), l’inventaire de produits est automatiquement mis à niveau vers la version de la commande en modifiant la spécification du produit référencé. Cela permet à la commande d’être traitée avec succès. Lorsque cette propriété système est définie sur faux, si l’inventaire des produits est une version différente de celle indiquée dans la commande, la commande échoue en raison d’une incompatibilité de version. Type de données : objet `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Requis. Version initiale ou ID externe de la spécification du produit. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
élémentcommandeproduit.produit.spécificationsproduit.versioninterne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
élémentcommandeproduit.produit.spécifications.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste des rôles de partie liés à un OrderLineItemContact. Type de données : tableau d’objets `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne Stocké dans : Le champ E-mail de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne Stocké dans : Le champ first_name de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Stocké dans : Le champ lastName de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne Stocké dans : Le champ business_phone de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.@referredType	Requis. Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `Produit`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Requis. Description de l’offre de produit associée au produit. Type de données : objet `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Requis. Version initiale ou ID externe de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nom de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
produitCommandeÉlément.produitÉlémentCommande.quantité	Nombre des éléments associés à commander. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : nul
productOrderItem.productOrderItemRelationship	Requis. Liste qui décrit la relation parent/enfant entre les éléments de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Requis. Identique à la productOrderItem.id valeur. Utilisé pour la relation parent/enfant Type de données : chaîne Stocké dans : Le champ parent_line_item de la table sn_ind_tmt_orm_order_line_item. Valeur par défaut : chaîne vide
productOrderItem.productOrderItemRelationship.relationshipType	Requis. Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Type de données : chaîne
productOrderItem.quantity	Nombre d’éléments commandés. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte ou du contact client associé à la commande. Type de données : chaîne Table : compte [customer_account], table Contact [customer_contact] ou consommateur [csm_consumer]
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Requis. Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

En-têtes

Tableau 46. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 47. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 48. Codes d'état
Code d'état	Description
201	Réussi. En cas de problème avec les caractéristiques ou les informations d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé : `Les caractéristiques suivantes de l’élément de commande n’existent pas : examinez les <characteristic.name de spécification> et corrigez la caractéristique et l’option de caractéristique dans l’élément de ligne de commande avant d’approuver la commande.` `Caractéristique de l’élément de commande : <characteristic.name> avec une valeur caractéristique : <characteristic.value>n’est pas valide. Corrigez les valeurs caractéristiques avant d’approuver la commande.`
202	Accepté. Demande réussie pour une commande en mode asynchrone. En d’autres termes, la demande a été effectuée avec le mode paramètre réglé sur `asynchrone` et le traitement de l’enregistrement est planifié dans la table File d’attente entrante [sn_tmt_core_inbound_queue].
400	Demande incorrecte. Peut être l’une des raisons suivantes : `Charge utile non valide : corps de la demande manquant : la` charge utile n’a pas été transmise dans le corps de la demande. `Charge utile non valide : productOrderItem est manquant :` objet d’élément de ligne de commande de produit ou JSON manquant. `Charge utile non valide : l’ID productOrderItem est manquant :` le id paramètre est manquant dans l’élément de ligne de commande de produit de la charge utile. `Charge utile non valide : l’action productOrderItem est manquante :` le action paramètre est manquant dans l’élément de ligne de commande de produit de la charge utile. `Charge utile non valide : productOrderItem productOffering est manquant` : l’objet d’offre de produit ou le JSON est manquant dans l’élément de ligne de commande de produit dans la charge utile. `Charge utile non valide : l’ID productOffering est manquant :`id le paramètre est manquant dans l’élément de ligne de commande de produit de l’objet d’offre de produit dans la charge utile. `Charge utile non valide : L’offre de produit n’existe pas :` l’offre de produit dans l’élément de ligne de commande du produit n’est pas valide. `Charge utile non valide : produit productOrderItem manquant` : l’objet produit ou le JSON dans l’élément de ligne de commande du produit est manquant dans la charge utile. `Charge utile non valide : product Specification est manquant` : l’objet de spécification de produit ou le JSON dans l’élément de ligne de commande de produit est manquant dans la charge utile. `Charge utile non valide : l’ID de spécification produit est manquant :` le id paramètre de l’élément de ligne de commande de produit de l’objet de spécification de produit est manquant dans la charge utile. `Charge utile non valide : la spécification du produit n’existe pas :` la spécification du produit dans l’élément de ligne de commande du produit n’est pas valide. `Charge utile non valide : L’inventaire de produits n’existe pas` - Dans un ordre de changement (action = changement), la quantité d’un élément est supérieure à ce qui est en stock. `Charge utile non valide : L’ID d’inventaire de produits est manquant` : dans l’ordre de changement, il manque dans product.id la charge utile. `Charge utile non valide : le produit vendu est inactif :` dans un ordre de changement, un produit spécifié dans la charge utile est inactif. `Charge utile non valide : relatedParty est manquant :` l’objet de partie connexe est manquant dans la charge utile. `Charge utile non valide : le compte client ou le consommateur est manquant` : le client ou l’objet consommateur tiers connexe est manquant dans la charge utile. `Charge utile non valide : le consommateur n’existe pas :` le consommateur tiers associé spécifié n’existe pas dans l’instance ServiceNow . `Charge utile non valide : Le compte client n’existe pas` : le client tiers associé spécifié n’existe pas dans l’instance ServiceNow . `Charge utile non valide : Échec` de la création de la commande - Impossible de créer la commande demandée. `Charge utile non valide : orderCurrency est requis :` le orderCurrency paramètre est manquant dans la charge utile. `Code de devise inactive : <devise>` : la devise fournie est inactive dans l’instance ServiceNow . `Un ou plusieurs éléments de ligne ont un code de devise différent de celui de la devise de la commande` : tous les éléments de ligne n’ont pas le même code de devise que la devise de la commande. `Révision en cours de la devise de commande non prise en charge` : le orderCurrency paramètre ne peut pas être mis à jour une fois la commande créée.

Paramètres de corps de réponse (JSON)


Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne
channel.name	Nom du canal à utiliser pour vendre les produits associés. Type de données : chaîne
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne
externalId	Identificateur externe du bon de commande, tel qu’un numéro de bon de commande. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de produit. Type de données : chaîne
id	Sys_id de la commande de client créée pour cette demande. Type de données : chaîne
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]`
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
orderCurrency	Code de devise pour la commande et les éléments de ligne de bon de commande. Type de données : chaîne
orderId	Sys_id de la commande à créer. En cas de réussite de la demande, la commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] sur un calendrier pour être traitée. Remarque : Cette valeur est le seul résultat si la commande est créée de manière asynchrone à l’aide du mode paramètre query. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Type de données : chaîne
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
produitÉlémentCommande.action	Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
productOrderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne
productOrderItem.externalProductInventory	Liste des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire de produits. Type de données : chaîne
productOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
produitCommandeÉlément.élémentPrix.prix.taxIncludeMontant.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne
produitCommandeÉlément.élémentPrix.prix.taxIncludeMontant.valeur	Prix du produit, taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
produitCommandeÉlément.produit	Description des détails d’instance du produit acheté par le client. Type de données : objet `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	Identificateur unique du produit vendu. Situé dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Ce paramètre n’est renvoyé que si productOrderItem.action les options sont `Modifier` ou `Supprimer`. Si sys_id et external_id sont présents, la external_id est renvoyée. Type de données : chaîne
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
produitCommandeÉlément.produit.produitRelation	Liste des détails de relation de produit pour un élément de ligne de commande. Type de données : tableau `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	Sys_id ou sn_prd_invt_external_id de l’inventaire des produits. Type de données : chaîne Table : champ Sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory].
produitÉlémentCommande.produit.produitRelationship.relationshipType	Type de relation entre l’élément de ligne de commande et l’inventaire des produits. Valeur possible : nécessite Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Si sys_id et external_id sont présents, la external_id est renvoyée. Type de données : chaîne
productOrderItem.product.productSpecification.internalId	Version initiale de la spécification du produit. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
élémentcommandeproduit.produit.spécificationsproduit.versioninterne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
élémentcommandeproduit.produit.spécifications.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Type de données : chaîne
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `Produit`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Si sys_id et external_id sont présents, la external_id est renvoyée. Type de données : chaîne
productOrderItem.productOffering.internalId	Version initiale de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
productOrderItem.quantity	Nombre des éléments associés à commander. Type de données : nombre
productOrderItem.state	État actuel de l’élément de commande de produit. Cette valeur est toujours `nouvelle`. Type de données : chaîne
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.type	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
État	État actuel de la commande. Pour ce point de terminaison, cette valeur est toujours `nouvelle`. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Traitement asynchrone

Cet exemple montre comment utiliser le mode paramètre de requête pour créer une commande de manière asynchrone. La commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] sur un calendrier à créer.

curl -X POST 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder?mode=async' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
  "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
  "requestedStartDate": "2020-05-03T08:13:59.506Z",
  "orderDate": "2020-05-03T08:13:59.506Z",
  "externalId": "PO-4ddd56",
  "orderCurrency": "USD",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "productOrderItem": [
    {
      "id": "100",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "firstName": "John",
            "lastName": "Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "productRelationship": [
          {
            "id": "be6d13f45b5620102dff5e92dc81c781",
            "relationshipType": "Requires"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "110",
          "relationshipType": "HasChild"
        },
        {
          "id": "120",
          "relationshipType": "HasChild"
        },
        {
          "id": "130",
          "relationshipType": "HasChild"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "110",
      "quantity": 1,
      "action": "add",
      "itemPrice": [
        {
          "description": "Access Fee",
          "name": "Access Fee",
          "priceType": "nonRecurring",
          "price": {
            "taxRate": 0,
            "dutyFreeAmount": {
              "unit": "USD",
              "value": 100
            },
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 220
            }
          }
        }
      ],
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Tenancy",
            "valueType": "string",
            "value": "Premium (>50 sites)"
          }
        ],
        "productSpecification": {
          "id": "216663aa53702010cd6dddeeff7b12b5",
          "name": "SD-WAN Controller",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "@type": "Place",
          "id": "5671dd2ec3a53010188473ce3640dd81"
        },
        "relatedParty": [
          {
            "firstName": "John",
            "lastName": "Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "productRelationship": [
          {
            "id": "be6d13f45b5620102dff5e92dc81c781",
            "relationshipType": "Requires"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "120",
      "action": "add",
      "actionReason":"adding service package OLI",
      "quantity": 1,
      "itemPrice": [
        {
          "description": "Tariff plan monthly fee",
          "name": "MonthlyFee",
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxRate": 0,
            "dutyFreeAmount": {
              "unit": "USD",
              "value": 300
            },
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 349
            }
          }
        }
      ],
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "CPE Model",
            "valueType": "string",
            "value": "ASR"
          },
          {
            "name": "WAN Optimization",
            "valueType": "string",
            "value": "Advance"
          },
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Physical"
          },
          {
            "name": "Routing",
            "valueType": "string",
            "value": "Premium"
          }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "@type": "Place",
          "id": "5671dd2ec3a53010188473ce3640dd81"
        },
        "relatedParty": [
          {
            "firstName": "John",
            "lastName": "Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "productRelationship": [
          {
            "id": "be6d13f45b5620102dff5e92dc81c781",
            "relationshipType": "Requires"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "130",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "description": "Tariff plan monthly security",
          "name": "MonthlySecurity",
          "priceType": "nonRecurring",
          "price": {
            "taxRate": 0,
            "dutyFreeAmount": {
              "unit": "USD",
              "value": 30
            },
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 30
            }
          }
        }
      ],
      "product": {
        "isBundle": false,
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "valueType": "string",
            "value": "Premium"
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "@type": "Place",
          "id": "5671dd2ec3a53010188473ce3640dd81"
        },
        "relatedParty": [
          {
            "firstName": "John",
            "lastName": "Smith",
            "email": "abc2@example.com",
            "phone": "32456768",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "productRelationship": [
          {
            "id": "be6d13f45b5620102dff5e92dc81c781",
            "relationshipType": "Requires"
          }
        ]
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "@type": "ProductOrder"
}'

Corps de la réponse.

{
  "orderId": "304e877ac3ab5110856d73ce3640dde5"
}

Traitement synchrone (par défaut)

L’exemple suivant montre comment créer une commande de produit.

curl -X POST "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
  "requestedStartDate": "2020-05-03T08:13:59.506Z",
  "externalId": "PO-456",
  "currencyCode": "USD",
  "channel": [
    {
      "id": "2",
      "name": "Online channel"
    }
  ],
  "note": [
    {
      "text": "This is a TMF product order illustration"
    },
    {
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "productOrderItem": [
    {
      "id": "POI100",
      "quantity": 1,
      "action": "change",
      "product": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "@type": "Product",
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI120",
          "relationshipType": "HasChild"
        },
        {
          "id": "POI130",
          "relationshipType": "HasChild"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI120",
      "quantity": 1,
      "action": "change",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "id": "766d13f45b5620102dff5e92dc81c78a",
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "WAN Optimization",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "@type": "ProductSpecificationRef"
        },
        "productRelationship": [
           {
              "id": "326d13f45b5620102dff5e92dc81c785",
              "relationshipType": "Requires"
           }
        ],
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        },
        {
          "id": "POI130",
          "relationshipType": "Requires"
        }  
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI130",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "@type": "ProductOrder"
}

Corps de la réponse.

{
  "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
  "requestedStartDate": "2020-05-03T08:13:59.506Z",
  "externalId": "PO-456",
  "currencyCode": "USD",
  "channel": [
    {
      "id": "2",
      "name": "Online chanel"
    }
  ],
  "note": [
    {
      "text": "This is a TMF product order illustration"
    },
    {
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "productOrderItem": [
    {
      "id": "POI100",
      "quantity": 1,
      "action": "change",
      "actionReason":"adding service package OLI",
      "product": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "@type": "Product",
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "internalVersion": "1",
          "version": "v1",
          "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering",
        "internalVersion": "1",
        "version": "v1",
        "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI120",
          "relationshipType": "HasChild"
        },
        {
          "id": "POI130",
          "relationshipType": "HasChild"
        }
      ],
      "@type": "ProductOrderItem",
      "state": "new"
    },
    {
      "id": "POI120",
      "quantity": 1,
      "action": "change",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "id": "766d13f45b5620102dff5e92dc81c78a",
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "WAN Optimization",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "internalVersion": "1",
          "version": "v1",
          "internalId": "39b627aa53702010cd6dddeeff7b1202",
          "@type": "ProductSpecificationRef"
        },
        "productRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ],
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering",
        "internalVersion": "1",
        "version": "v1",
        "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        },
        {
          "id": "POI130",
          "relationshipType": "Requires"
        }  
      ],
      "@type": "ProductOrderItem",
      "state": "new"
    },
    {
      "id": "POI130",
      "quantity": 1,
      "action": "add",
      "actionReason":"adding service package OLI",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "internalVersion": "1",
          "version": "v1",
          "internalId": "a6514bd3534560102f18ddeeff7b1247",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering",
        "internalVersion": "1",
        "version": "v1",
        "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem",
      "state": "new"
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "@type": "ProductOrder",
  "id": "8d75939453126010a795ddeeff7b126a",
  "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
  "state": "new"
}

API ouverte de commande de produit : POST /sn_ind_tmt_orm/productorder

Crée la commande client et les éléments de ligne de commande client spécifiés.

Important :

À partir de la mise en Tokyo production, ce point de terminaison est obsolète. La nouvelle version de ce point de terminaison est API ouverte de commande de produit : POST /sn_ind_tmt_orm/order/productOrder.

Une fois traités, de nouveaux enregistrements sont créés dans les tables suivantes :

Commande de clients [sn_ind_tmt_orm_order]
Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
Contact d’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]

Format d'URL

URL par défaut : /api/sn_ind_tmt_orm/productorder

Paramètres de demande pris en charge

Tableau 49. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 50. Paramètres de requête
Nom	Description
Aucun

Tableau 51. Paramètres du corps de la demande (JSON)
Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
channel.id	Requis. Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs de l’ID de canal se trouvent dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne Stocké dans : Le champ Canal de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
channel.name	Nom du canal à utiliser pour vendre les produits associés. Les noms de canaux possibles sont définis dans l’onglet Liste de choix de l’entrée du dictionnaire des canaux de la table sn_ind_tmt_orm_order. Type de données : chaîne Valeur par défaut : chaîne vide
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table sn_ind_tmt_orm_order.
externalId	Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
remarque	Remarques supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
note.text	Requis. Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : Le champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
orderCurrency	Requis. Code de devise pour la commande et les éléments de ligne de bon de commande. La devise doit être la même pour tous les éléments de la commande et des éléments de ligne de commande, sinon une erreur est renvoyée et la commande n’est pas créée. Une fois qu’une commande est créée, son code de devise ne peut pas être modifié. Type de données : chaîne
productOrderItem	Requis. Éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
produitÉlémentCommande.action	Requis. Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles : ajouter changement supprimer Aucun changement reprendre suspendre Type de données : chaîne Stocké dans : Le champ d’action de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
productOrderItem.actionReason	Facultatif. Description du motif de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
productOrderItem.externalProductInventory	ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : Champ external_inventory_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] et champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory.
productOrderItem.id	Requis. Identificateur unique de l’élément de ligne. Type de données : chaîne Stocké dans : Le champ external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Longueur maximale : 40 Valeur par défaut : chaîne vide
productItemItem.itemPrice	Prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Stocké dans : sn_ind_tmt_orm_order Valeur par défaut : chaîne vide
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.unité	Code de devise dans lequel le prix est exprimé. Type de données : chaîne Stocké dans : champ mrc ou nrc de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
produitCommandeÉlément.élémentPrix.prix.taxIncludedAmount.valeur	Prix du produit, taxes comprises. Type de données : nombre Stocké dans : champ mrc ou nrc de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
productOrderItem.itemPrice.priceType	Spécifie si le prix de l’élément est récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
produitCommandeÉlément.produit	Requis si productOrderItem.action est modifier ou supprimer. Détails d’instance du produit acheté par le client. Type de données : objet `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
productOrderItem.product.id	Requis si productOrderItem.action est modifier ou supprimer. Identificateur unique du produit vendu. Type de données : chaîne Valeur par défaut : chaîne vide Table : dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory].
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }` Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
productOrderItem.product.place.id	Requis. Sys_id de l’enregistrement de l’emplacement associé. Type de données : chaîne Table : Emplacement [cmn_location] Stocké dans : champ Emplacement de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
productOrderItem.product.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Caractéristiques du produit associé. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Type de données : chaîne Table : Caractéristique [sn_prd_pm_characteristic] Stocké dans : Le champ des caractéristiques de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : champ previous_characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : Le champ characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide
productItemOrder.product.productCharacteristic.valueType	Type de valeur caractéristique. Valeurs possibles : Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Tableau.Test sur ligne unique Case à cocher Choix Date, adresse E-mail Entier,Date/heure Objet Texte sur ligne unique Oui/Non Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Facultatif. Description de la spécification du produit associée au produit. Remarque : Les ordres de changement (productOrderItem.action est `un changement`) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. La valeur de cette propriété système détermine le mode de traitement de la commande si l’inventaire des produits est une version différente de celle indiquée dans la commande. Lorsque cette propriété système est définie sur vrai (par défaut), l’inventaire de produits est automatiquement mis à niveau vers la version de la commande en modifiant la spécification du produit référencé. Cela permet à la commande d’être traitée avec succès. Lorsque cette propriété système est définie sur faux, si l’inventaire des produits est une version différente de celle indiquée dans la commande, la commande échoue en raison d’une incompatibilité de version. Type de données : objet `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Requis. Version initiale ou ID externe de la spécification du produit. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
élémentcommandeproduit.produit.spécificationsproduit.versioninterne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
élémentcommandeproduit.produit.spécifications.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste des rôles de partie liés à un OrderLineItemContact. Type de données : tableau d’objets `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne Stocké dans : Le champ E-mail de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne Stocké dans : Le champ first_name de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Stocké dans : Le champ lastName de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne Stocké dans : Le champ business_phone de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.@referredType	Requis. Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `Produit`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Requis. Description de l’offre de produit associée au produit. Type de données : objet `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Requis. Version initiale ou ID externe de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Nom de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
productOrderItem.productOffering.version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
produitCommandeÉlément.produitÉlémentCommande.quantité	Nombre des éléments associés à commander. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : nul
productOrderItem.productOrderItemRelationship	Requis. Liste qui décrit la relation parent/enfant entre les éléments de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Stocké dans : sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Requis. Identique à la productOrderItem.id valeur. Utilisé pour la relation parent/enfant Type de données : chaîne Stocké dans : Le champ parent_line_item de la table sn_ind_tmt_orm_order_line_item. Valeur par défaut : chaîne vide
productOrderItem.productOrderItemRelationship.relationshipType	Requis. Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Type de données : chaîne
productOrderItem.quantity	Nombre d’éléments commandés. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte ou du contact client associé à la commande. Type de données : chaîne Table : compte [customer_account], table Contact [customer_contact] ou consommateur [csm_consumer]
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Requis. Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

En-têtes

Tableau 52. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 53. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 54. Codes d'état
Code d'état	Description
201	Réussi. En cas de problème avec les caractéristiques ou les informations d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé : `Les caractéristiques suivantes de l’élément de commande n’existent pas : examinez les <characteristic.name de spécification> et corrigez la caractéristique et l’option de caractéristique dans l’élément de ligne de commande avant d’approuver la commande.` `Caractéristique de l’élément de commande : <characteristic.name> avec une valeur caractéristique : <characteristic.value>n’est pas valide. Corrigez les valeurs caractéristiques avant d’approuver la commande.`
400	Demande incorrecte. Peut être l’une des raisons suivantes : `Charge utile non valide : corps de la demande manquant : la` charge utile n’a pas été transmise dans le corps de la demande. `Charge utile non valide : productOrderItem est manquant :` objet d’élément de ligne de commande de produit ou JSON manquant. `Charge utile non valide : l’ID productOrderItem est manquant :` le id paramètre est manquant dans l’élément de ligne de commande de produit de la charge utile. `Charge utile non valide : l’action productOrderItem est manquante :` le action paramètre est manquant dans l’élément de ligne de commande de produit de la charge utile. `Charge utile non valide : productOrderItem productOffering est manquant` : l’objet d’offre de produit ou le JSON est manquant dans l’élément de ligne de commande de produit dans la charge utile. `Charge utile non valide : l’ID productOffering est manquant :`id le paramètre est manquant dans l’élément de ligne de commande de produit de l’objet d’offre de produit dans la charge utile. `Charge utile non valide : L’offre de produit n’existe pas :` l’offre de produit dans l’élément de ligne de commande du produit n’est pas valide. `Charge utile non valide : produit productOrderItem manquant` : l’objet produit ou le JSON dans l’élément de ligne de commande du produit est manquant dans la charge utile. `Charge utile non valide : product Specification est manquant` : l’objet de spécification de produit ou le JSON dans l’élément de ligne de commande de produit est manquant dans la charge utile. `Charge utile non valide : l’ID de spécification produit est manquant :` le id paramètre de l’élément de ligne de commande de produit de l’objet de spécification de produit est manquant dans la charge utile. `Charge utile non valide : la spécification du produit n’existe pas :` la spécification du produit dans l’élément de ligne de commande du produit n’est pas valide. `Charge utile non valide : L’inventaire de produits n’existe pas` - Dans un ordre de changement (action = changement), la quantité d’un élément est supérieure à ce qui est en stock. `Charge utile non valide : L’ID d’inventaire de produits est manquant` : dans l’ordre de changement, il manque dans product.id la charge utile. `Charge utile non valide : le produit vendu est inactif :` dans un ordre de changement, un produit spécifié dans la charge utile est inactif. `Charge utile non valide : relatedParty est manquant :` l’objet de partie connexe est manquant dans la charge utile. `Charge utile non valide : le compte client ou le consommateur est manquant` : le client ou l’objet consommateur tiers connexe est manquant dans la charge utile. `Charge utile non valide : le consommateur n’existe pas :` le consommateur tiers associé spécifié n’existe pas dans l’instance ServiceNow . `Charge utile non valide : Le compte client n’existe pas` : le client tiers associé spécifié n’existe pas dans l’instance ServiceNow . `Charge utile non valide : Échec` de la création de la commande - Impossible de créer la commande demandée.

Paramètres de corps de réponse (JSON)


Nom	Description
canal	Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne
channel.name	Nom du canal à utiliser pour vendre les produits associés. Type de données : chaîne
id	Sys_id de la commande de client créée pour cette demande. Type de données : chaîne
externalId	Identificateur externe du bon de commande, tel qu’un numéro de bon de commande. Type de données : chaîne
remarque	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]`
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
productOrderItem	Liste qui décrit les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets `"productOrderItem:" [ { "action": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
produitÉlémentCommande.action	Action à effectuer sur le produit. Les actions possibles sont définies sous l’onglet Liste de choix dans l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
productOderItem.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
productOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productItemItem.itemPrice	Liste qui décrit le prix associé au produit. Type de données : tableau d’objets `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
produitCommandeÉlément.PrixArticle.Prix	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Description du prix du produit associé, taxe comprise. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
produitCommandeÉlément.élémentPrix.prix.taxIncludeMontant.unité	Code de devise dans lequel le prix est représenté. Type de données : chaîne
produitCommandeÉlément.élémentPrix.prix.taxIncludeMontant.valeur	Prix du produit, taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne
produitCommandeÉlément.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période récurrente, par exemple `le mois`. Type de données : chaîne
produitCommandeÉlément.produit	Description des détails d’instance du produit acheté par le client. Type de données : objet `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	Identificateur unique du produit vendu. Situé dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Ce paramètre n’est renvoyé que si productOrderItem.action les options sont `Modifier` ou `Supprimer`. Si sys_id et external_id sont présents, la external_id est renvoyée. Type de données : chaîne
productOrderItem.product.place	Cartes des emplacements d’installation du produit. Type de données : objet `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
élémentcommandeproduit.produit.caractéristiqueduproduit	Liste des caractéristiques du produit associé. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeurprécédente	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`productOrderItem.action. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
élémentcommandeproduit.produit.produitcaractéristique.valeur	Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
productItemOrder.product.productCharacteristic.valueType	Type de valeur caractéristique. Valeurs possibles : Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Tableau.Test sur ligne unique Case à cocher Choix Date, adresse E-mail Entier,Date/heure Objet Texte sur ligne unique Oui/Non Type de données : chaîne
produitCommandeÉlément.produit.produitSpécification	Description de la spécification du produit associée au produit. Type de données : objet `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications du produit [sn_prd_pm_product_specification]. Si sys_id et external_id sont présents, la external_id est renvoyée. Type de données : chaîne
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification du produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ProductSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
élémentcommandeproduit.produit.partieconnexe.prénom	Prénom du contact. Type de données : chaîne
produitCommandeÉlément.produit.partieconnexe.nom de famille	Nom de famille du contact. Type de données : chaîne Type de données : chaîne
productOrderItem.product.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
productOrderItem.product.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
productOrderItem.product.relatedParty.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `RelatedParty`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `Produit`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.productOffering	Description de l’offre de produit associée au produit. Type de données : objet `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produit [sn_prd_pm_product_offering]. Si sys_id et external_id sont présents, la external_id est renvoyée. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItemRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
productOrderItem.productOrderItemRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Type de données : chaîne
productOrderItem.quantity	Nombre des éléments associés à commander. Type de données : nombre
productOrderItem.state	État actuel de l’élément de commande de produit. Cette valeur est toujours `nouvelle`. Type de données : chaîne
productOrderItem.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.type	Type de client. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
État	État actuel de la commande. Pour ce point de terminaison, cette valeur est toujours `nouvelle`. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours `ProductOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Demande cURL

L’exemple de code suivant crée une commande client.

curl -X POST "https://servicenow-instance/api/sn_ind_tmt_orm/productorder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
  "requestedStartDate": "2020-05-03T08:13:59.506Z",
  "externalId": "PO-456",
  "channel": [
    {
      "id": "2",
      "name": "Online channel"
    }
  ],
  "note": [
    {
      "text": "This is a TMF product order illustration"
    },
    {
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "productOrderItem": [
    {
      "id": "POI100",
      "quantity": 1,
      "action": "change",
      "product": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "@type": "Product",
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "@type": "ProductSpecificationRef"
        },
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI120",
          "relationshipType": "HasChild"
        },
        {
          "id": "POI130",
          "relationshipType": "HasChild"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI120",
      "quantity": 1,
      "action": "change",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "id": "766d13f45b5620102dff5e92dc81c78a",
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "WAN Optimization",
            "valueType": "Object",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "39b627aa53702010cd6dddeeff7b1202",
          "name": "SD-WAN Edge Device",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "id": "POI130",
      "quantity": 1,
      "action": "add",
      "itemPrice": [
        {
          "priceType": "recurring",
          "recurringChargePeriod": "month",
          "price": {
            "taxIncludedAmount": {
              "unit": "USD",
              "value": 20
            }
          }
        }
      ],
      "product": {
        "@type": "Product",
        "productCharacteristic": [
          {
            "name": "Security Type",
            "valueType": "Object",
            "value": "Base",
            "previousValue": "Advance"
          }
        ],
        "productSpecification": {
          "id": "a6514bd3534560102f18ddeeff7b1247",
          "name": "SD-WAN Security",
          "@type": "ProductSpecificationRef"
        },
        "relatedParty": [
          {
            "id": "51670151c35420105252716b7d40ddfe",
            "firstName": "Joe",
            "lastName": "Doe",
            "email": "abc@example.com",
            "phone": "1234567890",
            "@type": "RelatedParty",
            "@referredType": "OrderLineItemContact"
          }
        ],
        "place": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "@type": "Place"
        }
      },
      "productOffering": {
        "id": "69017a0f536520103b6bddeeff7b127d",
        "name": "Premium SD-WAN Offering"
      },
      "productOrderItemRelationship": [
        {
          "id": "POI100",
          "relationshipType": "HasParent"
        }
      ],
      "@type": "ProductOrderItem"
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "@type": "ProductOrder"
}

Corps de la réponse.

{
    "requestedCompletionDate": "2021-05-02T08:13:59.506Z",
    "requestedStartDate": "2020-05-03T08:13:59.506Z",
    "externalId": "PO-456",
    "channel": [
        {
            "id": "2",
            "name": "Online chanel"
        }
    ],
    "note": [
        {
            "text": "This is a TMF product order illustration"
        },
        {
            "text": "This is a TMF product order illustration no 2"
        }
    ],
    "productOrderItem": [
        {
            "id": "POI100",
            "quantity": 1,
            "action": "change",
            "product": {
                "id": "fa6d13f45b5620102dff5e92dc81c77f",
                "@type": "Product",
                "productSpecification": {
                    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
                    "name": "SD-WAN Service Package",
                    "@type": "ProductSpecificationRef"
                },
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI120",
                    "relationshipType": "HasChild"
                },
                {
                    "id": "POI130",
                    "relationshipType": "HasChild"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        },
        {
            "id": "POI120",
            "quantity": 1,
            "action": "change",
            "itemPrice": [
                {
                    "priceType": "recurring",
                    "recurringChargePeriod": "month",
                    "price": {
                        "taxIncludedAmount": {
                            "unit": "USD",
                            "value": 20
                        }
                    }
                }
            ],
            "product": {
                "id": "766d13f45b5620102dff5e92dc81c78a",
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "WAN Optimization",
                        "valueType": "Object",
                        "value": "Base",
                        "previousValue": "Advance"
                    }
                ],
                "productSpecification": {
                    "id": "39b627aa53702010cd6dddeeff7b1202",
                    "name": "SD-WAN Edge Device",
                    "@type": "ProductSpecificationRef"
                },
                "relatedParty": [
                    {
                        "id": "51670151c35420105252716b7d40ddfe",
                        "firstName": "Joe",
                        "lastName": "Doe",
                        "email": "abc@example.com",
                        "phone": "1234567890",
                        "@type": "RelatedParty",
                        "@referredType": "OrderLineItemContact"
                    }
                ],
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI100",
                    "relationshipType": "HasParent"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        },
        {
            "id": "POI130",
            "quantity": 1,
            "action": "add",
            "itemPrice": [
                {
                    "priceType": "recurring",
                    "recurringChargePeriod": "month",
                    "price": {
                        "taxIncludedAmount": {
                            "unit": "USD",
                            "value": 20
                        }
                    }
                }
            ],
            "product": {
                "@type": "Product",
                "productCharacteristic": [
                    {
                        "name": "Security Type",
                        "valueType": "Object",
                        "value": "Base",
                        "previousValue": "Advance"
                    }
                ],
                "productSpecification": {
                    "id": "a6514bd3534560102f18ddeeff7b1247",
                    "name": "SD-WAN Security",
                    "@type": "ProductSpecificationRef"
                },
                "relatedParty": [
                    {
                        "id": "51670151c35420105252716b7d40ddfe",
                        "firstName": "Joe",
                        "lastName": "Doe",
                        "email": "abc@example.com",
                        "phone": "1234567890",
                        "@type": "RelatedParty",
                        "@referredType": "OrderLineItemContact"
                    }
                ],
                "place": {
                    "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
                    "@type": "Place"
                }
            },
            "productOffering": {
                "id": "69017a0f536520103b6bddeeff7b127d",
                "name": "Premium SD-WAN Offering"
            },
            "productOrderItemRelationship": [
                {
                    "id": "POI100",
                    "relationshipType": "HasParent"
                }
            ],
            "@type": "ProductOrderItem",
            "state": "new"
        }
    ],
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "@type": "ProductOrder",
    "id": "6be0a925c3a220103e2e73ce3640ddfe",
    "state": "new"
}