API ouverte pour la commande de produits

Rversion finale: Washingtondc

Mis à jour 1 févr. 2024

156 minutes de lecture

L’API ouverte de commande de produits fournit 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 inclut les caractéristiques de produit pertinentes qui capturent les options uniques d’un produit, ainsi que d’autres attributs pertinents tels que la tarification, 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 de l’API ouverte pour 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 TM Forum et est certifiée conforme par TM Forum.

Logo de conformité TMF

Ouvrir l’API de la 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 de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]
Éléments de ligne de commande connexes [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. Si ce paramètre n’est pas utilisé, tous les champs sont renvoyés. Type de données : chaîne
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le offset paramètre pour paginer la récupération des enregistrements. Par défaut : 20 Maximum : 100 Type de données : nombre
décalage	Index de départ auquel commencer la récupération d’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. Par défaut : 0 Type de données : nombre
É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

Tableau 3. Paramètres de corps de demande (JSON)
Nom	Description
Néant

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 une 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	Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si `offset=2` et `limit=3`, la valeur de l’en-tête Content-Range correspond `aux é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 une 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 entière renvoyée en réponse (aucune pagination).
206	Ressource partielle renvoyé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	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. 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 ultérieure aux valeurs de committedDueDate chaque élément de ligne 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 à 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
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.auteur	Nom d’utilisateur de la personne ayant 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.texte	Remarques/commentaires supplémentaires faits 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 commande. Type de données : chaîne
ponr	Marqueur indiquant si le point de non retour de la commande a été atteint. Valeurs valides : true : le point de non-retour de la commande a été atteint. false : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
Élément de commandeproduit.action	Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
Élément de commandeproduit.actionReason	Motif de l’ajout de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de commande. Type de données : chaîne
productOrderItem.externalProductInventory	Tableau d’objets contenant des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire des 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
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne
productOrderItem.itemPrice.price.taxIncludedAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `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 valides : true : le point de non-retour de la commande a été atteint. false : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
productOrderItem.product	Description des détails de l’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 sur lesquels installer le 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 TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Place`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Seules les caractéristiques du produit qui value sont différentes de celles previousValue sont retournées. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne
productOrderItem.product.productRelationship	Liste des détails sur la 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. Situé dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne
productOrderItem.product.productRelationship.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
productOrderItem.product.productSpecification	Description de la spécification de 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 de 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 Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalId	Initial_version de la spécification de produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de 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 de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.version	External_version de la spécification de produit. Situé dans la table Spécification de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"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
productOrderItem.product.relatedParty.firstName	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
productOrderItem.product.relatedParty.lastName	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 TMF Open API. 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 produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalId	Initial_version de l’offre de produit. Le initial_version est le sys_id de la première version de l’offre. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
produitCommandeArticle.quantité	Nombre d’éléments de produit achetés. Type de données : nombre
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"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 (en anglais seulement) 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 du 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 TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du client Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. 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 demandée)	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 TMF Open API. 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"
   }
]

Ouvrir l’API de la commande de produit : GET /sn_ind_tmt_orm/order/productOrder/{id}

Récupère la commande de produit 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 de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]
Éléments de ligne de commande connexes [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 du client à récupérer. Situé dans la table Commande client [sn_ind_tmt_orm_order]. Type de données : chaîne

Tableau 8. Paramètres de requête
Nom	Description
Néant

Tableau 9. Paramètres de corps de demande (JSON)
Nom	Description
Néant

En-têtes

Tableau 10. En-têtes de demandes
En-tête	Description
Néant

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 une 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 entière renvoyée en réponse (aucune pagination). La réponse est renvoyée avec un message d’erreur si la commande sélectionnée présente des problèmes de traitement. Une réponse 200 OK 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 200 OK se produit si une création de commande échoue et que l’enregistrement dans la table File d’attente entrante [sn_tmt_core_inbound_queue] est dans un état d’erreur. Le champ de message d’erreur inclut des détails pour l’enregistrement de la 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 renvoyé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	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. 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 ultérieure aux valeurs de committedDueDate chaque élément de ligne 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 à 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
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.auteur	Nom d’utilisateur de la personne ayant 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.texte	Remarques/commentaires supplémentaires faits 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 commande. Type de données : chaîne
ponr	Marqueur indiquant si le point de non retour de la commande a été atteint. Valeurs valides : true : le point de non-retour de la commande a été atteint. false : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"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" } ]`
Élément de commandeproduit.action	Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
Élément de commandeproduit.actionReason	Motif de l’ajout de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de commande. Type de données : chaîne
productOrderItem.externalProductInventory	Tableau d’objets contenant des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire des 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
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne
productOrderItem.itemPrice.price.taxIncludedAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `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 valides : true : le point de non-retour de la commande a été atteint. false : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
productOrderItem.product	Description des détails de l’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 sur lesquels installer le 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 TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Place`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Seules les caractéristiques du produit qui value sont différentes de celles previousValue sont retournées. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne
productOrderItem.product.productRelationship	Liste des détails sur la 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. Situé dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne
productOrderItem.product.productRelationship.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
productOrderItem.product.productSpecification	Description de la spécification de 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 de 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 Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalId	Initial_version de la spécification de produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de 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 de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.version	External_version de la spécification de produit. Situé dans la table Spécification de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"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
productOrderItem.product.relatedParty.firstName	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
productOrderItem.product.relatedParty.lastName	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 TMF Open API. 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 produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalId	Initial_version de l’offre de produit. Le initial_version est le sys_id de la première version de l’offre. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
produitCommandeArticle.quantité	Nombre d’éléments de produit achetés. Type de données : nombre
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"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 (en anglais seulement) 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 du 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 TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du client Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. 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 demandée)	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 TMF Open API. 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"
}

Ouvrir l’API de la commande de produit : GET /sn_ind_tmt_orm/productorder

Récupère toutes les commandes de produits.

Important :

À partir de la Tokyo version, ce point de terminaison est déconseillé. La nouvelle version de ce point de terminaison est Ouvrir l’API de la 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 de l’é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 sont renvoyés.
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le offset paramètre pour paginer la récupération des enregistrements. Par défaut : 20 Maximum : 100 Type de données : nombre
décalage	Index de départ auquel commencer la récupération d’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. Par défaut : 0 Type de données : nombre
É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 sont renvoyés.

Tableau 15. Paramètres de corps de demande (JSON)
Nom	Description
Néant

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	Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si `offset=2` et `limit=3`, la valeur de l’en-tête Content-Range correspond `aux é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 une 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 entière renvoyée en réponse (aucune pagination).
206	Ressource partielle renvoyé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	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. 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
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note": { "author": "String", "date": "String", "text": "String" }`
note.auteur	Nom d’utilisateur de la personne ayant 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.texte	Remarques/commentaires supplémentaires faits 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 valides : true : le point de non-retour de la commande a été atteint. false : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
Élément de commandeproduit.action	Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
Élément de commandeproduit.actionReason	Motif de l’ajout de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
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
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne
productOrderItem.itemPrice.price.taxIncludedAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `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 valides : true : le point de non-retour de la commande a été atteint. false : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
productOrderItem.product	Description des détails de l’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 sur lesquels installer le 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 TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Place`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Seules les caractéristiques du produit qui value sont différentes de celles previousValue sont retournées. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne
productOrderItem.product.productSpecification	Description de la spécification de 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 de 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 Spécification de 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 de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"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
productOrderItem.product.relatedParty.firstName	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
productOrderItem.product.relatedParty.lastName	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 TMF Open API. 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 produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
produitCommandeArticle.quantité	Nombre d’éléments de produit achetés. Type de données : nombre
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"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 (en anglais seulement) 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 du 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 TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du client Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. 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 demandée)	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 TMF Open API. 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"
   }
]

Ouvrir l’API de la commande de produit : GET /sn_ind_tmt_orm/productorder/{id}

Récupère la commande de produit 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 de l’é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 du client à récupérer. Situé dans la table Commande client [sn_ind_tmt_orm_order]. Type de données : chaîne

Tableau 20. Paramètres de requête
Nom	Description
Néant

Tableau 21. Paramètres de corps de demande (JSON)
Nom	Description
Néant

En-têtes

Tableau 22. En-têtes de demandes
En-tête	Description
Néant

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 une 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. Cela 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	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. 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
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note": { "author": "String", "date": "String", "text": "String" }`
note.auteur	Nom d’utilisateur de la personne ayant 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.texte	Remarques/commentaires supplémentaires faits 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 valides : true : le point de non-retour de la commande a été atteint. false : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
Élément de commandeproduit.action	Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
Élément de commandeproduit.actionReason	Motif de l’ajout de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
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
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne
productOrderItem.itemPrice.price.taxIncludedAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `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 valides : true : le point de non-retour de la commande a été atteint. false : le point de non-retour de la commande n’a pas été atteint. Type de données : booléennes
productOrderItem.product	Description des détails de l’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 sur lesquels installer le 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 TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Place`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Seules les caractéristiques du produit qui value sont différentes de celles previousValue sont retournées. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne
productOrderItem.product.productSpecification	Description de la spécification de 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 de 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 Spécification de 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 de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"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
productOrderItem.product.relatedParty.firstName	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
productOrderItem.product.relatedParty.lastName	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 TMF Open API. 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 produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
produitCommandeArticle.quantité	Nombre d’éléments de produit achetés. Type de données : nombre
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"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 (en anglais seulement) 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 du 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 TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du client Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. 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 demandée)	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 TMF Open API. 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 de 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 de 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 du client à mettre à jour. Situé dans la table Commande client [sn_ind_tmt_orm_order]. Type de données : chaîne

Tableau 26. Paramètres de requête
Nom	Description
Néant

Tableau 27. Paramètres de corps de demande (JSON)
Nom	Description
canal	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]` Table/champ mis à jour : 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. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/canal 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 ultérieure aux valeurs de committedDueDate chaque élément de ligne de commande. Si l’action des é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 Table/champ mis à jour : sn_ind_tmt_orm_order/committed_due_date
ID externe	Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/external_id Valeur par défaut : chaîne vide
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note:" [ { "text": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order
note.texte	Remarques/commentaires supplémentaires faits par le client lors de la commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/commentaires Valeur par défaut : chaîne vide
orderCurrency	Code de devise pour la commande et les éléments de ligne 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 sera rejetée. Type de données : chaîne
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"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" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
Élément de commandeproduit.action	Requis si le productOrderItem paramètre est utilisé. Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action Par défaut : add
Élément de commandeproduit.actionReason	Motif de l’ajout de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/committed_due_date
productOrderItem.externalProductInventory	Tableau d’objets contenant des ID externes à mapper vers les inventaires de produits créés pour la commande. Type de données : tableau `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_inventory_id et sn_prd_invt_product_inventory/sn_prd_invt_external_id
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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_id Longueur maximale : 40 Valeur par défaut : chaîne vide
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Table mise à jour : sn_ind_tmt_orm_order Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }` Table mise à jour : sn_ind_tmt_orm_order_line_item Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }` Table mise à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/mrc ou nrc
productOrderItem.itemPrice.price.taxIncludedAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/mrc ou nrc
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `le mois`. Type de données : chaîne
productOrderItem.product	Requis en cas de productOrderItem.action changement/déconnexion. Description des détails de l’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" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Requis en cas de productOrderItem.action changement/déconnexion. 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
produitCommandeArticle.produit.place	Cartes des emplacements sur lesquels installer le produit. Type de données : objet `"place:" { "id": "String", "@type": "String" }` Table/champ mis à jour : 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/emplacement Valeur par défaut : chaîne vide
productOrderItem.product.place.@type	Fait partie de la norme TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Place`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/caractéristiques Valeur par défaut : chaîne vide
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Valeur par défaut : chaîne vide
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Valeur par défaut : chaîne vide
productOrderItem.product.productSpecification	Description de la spécification de produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Table/champ mis à jour : 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 de 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 Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de 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 de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.version	External_version de la spécification de produit. Situé dans la table Spécification de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/e-mail Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.firstName	Prénom du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/first_name 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/sys_id Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/lastName Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/business_phone 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 TMF Open API. 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 TMF Open API. 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" }` Table mise à jour : 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 produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItem.quantity	Nombre d’éléments associés à commander. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order/quantité Valeur par défaut : null
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Table/champ mis à jour : 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/parent_line_item 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 (en anglais seulement) 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
produitCommandeArticle.quantité	Nombre d’éléments commandés. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order/quantité Valeur par défaut : chaîne vide
ArticleCommandeProduit.OpérationRévision	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é. Valeurs possibles : annuler aucun mettre à jour Type de données : chaîne Valeur par défaut : chaîne vide
productOrderItem.@type	Fait partie de la norme TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du client Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. 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 Table/champ mis à jour : sn_ind_tmt_orm_order/expected_end_date Valeur par défaut : chaîne vide
requestedStartDate (Date de début demandée)	Date de début de commande demandée par le client. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/expected_start_date Valeur par défaut : chaîne vide
@type	Fait partie de la norme TMF Open API. 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 une 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 informations sur les caractéristiques ou les options de caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs des notes de travail de l’enregistrement d’élément de ligne de commande client associé : `Les caractéristiques de l’article de commande suivantes n’existent pas : Examinez la spécification <characteristic.name> 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 de valider la commande.`
400	Demande incorrecte. Cela 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 :` l’objet ou le JSON de l’élément de ligne de commande de produit est manquant. `Charge utile non valide : l’ID de 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 ou le JSON de l’offre de produit 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 :` le id 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 de produit n’est pas valide. `Charge utile non valide : productOrderItem product est manquant :` l’objet produit ou JSON dans l’élément de ligne de commande de produit est manquant dans la charge utile. `Charge utile non valide : product productSpecification est manquant :` l’objet de spécification de produit ou 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 de produit est manquant :` le id paramètre dans 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 de produit n’existe pas` : la spécification de produit dans l’élément de ligne de commande de 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 un ordre de modification, il product.id est manquant dans la charge utile. `Charge utile non valide : le produit vendu est inactif` : dans un ordre de modification, un produit spécifié dans la charge utile est inactif. `Charge utile non valide : relatedParty est manquant` : l’objet de la partie associée est manquant dans la charge utile. `Le compte client ou le consommateur est manquant` : l’objet client ou consommateur de la partie associée est manquant dans la charge utile. `Charge utile non valide : Le consommateur n’existe pas` : le consommateur de la partie associée spécifiée 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 la 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 dans la file d’attente entrante pour plus de détails.` – L’ID de commande fourni n’est pas dans la table de commande du 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 est autre que livrer.

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


Nom	Description
canal	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. 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 ultérieure aux valeurs de committedDueDate chaque élément de ligne de commande. Type de données : chaîne
ID externe	Identificateur externe de la commande client, tel qu’un numéro de bon de commande. Type de données : chaîne
href	Lien relatif à 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
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note:" [ { "text": "String" } ]`
note.texte	Remarques/commentaires supplémentaires faits 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 commande. Type de données : chaîne
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
Élément de commandeproduit.action	Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
Élément de commandeproduit.actionReason	Motif de l’ajout de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de commande. Type de données : chaîne
productOrderItem.externalProductInventory	Tableau d’objets contenant des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire des 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
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne
productOrderItem.itemPrice.price.taxIncludeAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `le mois`. Type de données : chaîne
productOrderItem.product	Description des détails de l’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 sur lesquels installer le 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.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne
productOrderItem.product.productSpecification	Description de la spécification de 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 de 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 Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalId	Initial_version de la spécification de produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de 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 de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.version	External_version de la spécification de produit. Situé dans la table Spécification de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"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
productOrderItem.product.relatedParty.firstName	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
productOrderItem.product.relatedParty.lastName	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 TMF Open API. 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 TMF Open API. 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 produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalId	Initial_version de l’offre de produit. Le initial_version est le sys_id de la première version de l’offre. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"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
produitCommandeArticle.quantité	Nombre d’é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 TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du 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 demandée)	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 TMF Open API. 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 pour 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 de client spécifiée.

Important :

À partir de la Tokyo version, ce point de terminaison est déconseillé. 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 du client à mettre à jour. Situé dans la table Commande client [sn_ind_tmt_orm_order]. Type de données : chaîne

Tableau 32. Paramètres de requête
Nom	Description
Néant

Tableau 33. Paramètres de corps de demande (JSON)
Nom	Description
canal	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]` Table/champ mis à jour : 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. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/canal 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 ultérieure aux valeurs de committedDueDate chaque élément de ligne de commande. Si l’action des é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 Table/champ mis à jour : sn_ind_tmt_orm_order/committed_due_date
ID externe	Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/external_id Valeur par défaut : chaîne vide
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note:" [ { "text": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order
note.texte	Remarques/commentaires supplémentaires faits par le client lors de la commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/commentaires Valeur par défaut : chaîne vide
orderCurrency	Code de devise pour la commande et les éléments de ligne 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 sera rejetée. Type de données : chaîne
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"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" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
Élément de commandeproduit.action	Requis si le productOrderItem paramètre est utilisé. Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action Par défaut : add
Élément de commandeproduit.actionReason	Motif de l’ajout de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/committed_due_date
productOrderItem.externalProductInventory	Tableau d’objets contenant des ID externes à mapper vers les inventaires de produits créés pour la commande. Type de données : tableau `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_inventory_id et sn_prd_invt_product_inventory/sn_prd_invt_external_id
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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_id Longueur maximale : 40 Valeur par défaut : chaîne vide
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Table mise à jour : sn_ind_tmt_orm_order Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }` Table mise à jour : sn_ind_tmt_orm_order_line_item Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }` Table mise à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/mrc ou nrc
productOrderItem.itemPrice.price.taxIncludedAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/mrc ou nrc
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `le mois`. Type de données : chaîne
productOrderItem.product	Requis en cas de productOrderItem.action changement/déconnexion. Description des détails de l’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" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Requis en cas de productOrderItem.action changement/déconnexion. 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
produitCommandeArticle.produit.place	Cartes des emplacements sur lesquels installer le produit. Type de données : objet `"place:" { "id": "String", "@type": "String" }` Table/champ mis à jour : 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/emplacement Valeur par défaut : chaîne vide
productOrderItem.product.place.@type	Fait partie de la norme TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Place`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/caractéristiques Valeur par défaut : chaîne vide
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Valeur par défaut : chaîne vide
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Valeur par défaut : chaîne vide
productOrderItem.product.productSpecification	Description de la spécification de produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Table/champ mis à jour : 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 de 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 Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de 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 de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.version	External_version de la spécification de produit. Situé dans la table Spécification de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/e-mail Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.firstName	Prénom du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/first_name 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/sys_id Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/lastName Valeur par défaut : chaîne vide
produitCommandeÉlément.produit.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/business_phone 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 TMF Open API. 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 TMF Open API. 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" }` Table mise à jour : 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 produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItem.quantity	Nombre d’éléments associés à commander. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order/quantité Valeur par défaut : null
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Table/champ mis à jour : 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/parent_line_item 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 (en anglais seulement) 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
produitCommandeArticle.quantité	Nombre d’éléments commandés. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order/quantité Valeur par défaut : chaîne vide
ArticleCommandeProduit.OpérationRévision	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é. Valeurs possibles : annuler aucun mettre à jour Type de données : chaîne Valeur par défaut : chaîne vide
productOrderItem.@type	Fait partie de la norme TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du client Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. 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 Table/champ mis à jour : sn_ind_tmt_orm_order/expected_end_date Valeur par défaut : chaîne vide
requestedStartDate (Date de début demandée)	Date de début de commande demandée par le client. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/expected_start_date Valeur par défaut : chaîne vide
@type	Fait partie de la norme TMF Open API. 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 une 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 informations sur les caractéristiques ou les options de caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs des notes de travail de l’enregistrement d’élément de ligne de commande client associé : `Les caractéristiques de l’article de commande suivantes n’existent pas : Examinez la spécification <characteristic.name> 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 de valider la commande.`
400	Demande incorrecte. Cela 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 :` l’objet ou le JSON de l’élément de ligne de commande de produit est manquant. `Charge utile non valide : l’ID de 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 ou le JSON de l’offre de produit 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 :` le id 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 de produit n’est pas valide. `Charge utile non valide : productOrderItem product est manquant :` l’objet produit ou JSON dans l’élément de ligne de commande de produit est manquant dans la charge utile. `Charge utile non valide : product productSpecification est manquant :` l’objet de spécification de produit ou 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 de produit est manquant :` le id paramètre dans 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 de produit n’existe pas` : la spécification de produit dans l’élément de ligne de commande de 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 un ordre de modification, il product.id est manquant dans la charge utile. `Charge utile non valide : le produit vendu est inactif` : dans un ordre de modification, un produit spécifié dans la charge utile est inactif. `Charge utile non valide : relatedParty est manquant` : l’objet de la partie associée est manquant dans la charge utile. `Charge utile non valide : compte client ou consommateur manquant` : l’objet client ou consommateur partie connexe est manquant dans la charge utile. `Charge utile non valide : Le consommateur n’existe pas` : le consommateur de la partie associée spécifiée 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 dans la file d’attente entrante pour plus de détails.` - La demande de correctif a été effectuée pour une commande qui ne figure pas encore dans la table de commande du client. 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. `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 est différent deliver.

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


Nom	Description
canal	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. 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
ID externe	Identificateur externe de la commande client, tel qu’un numéro de bon de commande. Type de données : chaîne
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note:" [ { "text": "String" } ]`
note.texte	Remarques/commentaires supplémentaires faits par le client lors de la commande. Type de données : chaîne
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
Élément de commandeproduit.action	Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
Élément de commandeproduit.actionReason	Motif de l’ajout de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
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
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne
productOrderItem.itemPrice.price.taxIncludeAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `le mois`. Type de données : chaîne
productOrderItem.product	Description des détails de l’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 sur lesquels installer le 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.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne
productOrderItem.product.productSpecification	Description de la spécification de 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 de 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 Spécification de 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 de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"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
productOrderItem.product.relatedParty.firstName	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
productOrderItem.product.relatedParty.lastName	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 TMF Open API. 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 TMF Open API. 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 produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"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
produitCommandeArticle.quantité	Nombre d’é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 TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du 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 demandée)	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 TMF Open API. 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",
                        "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",
                        "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"
}

Ouvrir l’API de la commande de produit : POST /sn_ind_tmt_orm/cancelproductorder

Annule la commande du 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
Néant

Tableau 39. Paramètres de corps de demande (JSON)
Nom	Description
Motif de l’annulation	Motif de l’annulation. Type de données : chaîne Valeur par défaut : chaîne vide
Commande produit	Contient des données sur la commande de produit. Type de données : objet `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.id	Requis. Sys_id de la commande du client à annuler. Situé dans la table Commande client [sn_ind_tmt_orm_order]. Type de données : chaîne
commandeProduit.href	URL de la commande du 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 demandée)	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 une 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. Cela peut être l’une des raisons suivantes : Charge utile vide. Charge utile non valide. Champ obligatoire manquant : <nom du 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é effectuée pour une commande qui n’a pas encore été créée. La commande 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 de l’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 produit	Contient des données sur la commande de 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
commandeProduit.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 demandée)	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 `fournie`. 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 la commande d’un 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"
}

Ouvrir l’API de la 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 de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]
Éléments de ligne de commande connexes [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	Active le traitement asynchrone des commandes. C’est-à-dire que 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 possible : async Type de données : chaîne

Tableau 45. Paramètres de corps de demande (JSON)
Nom	Description
canal	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order
channel.id	Requis. Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/canal 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 ultérieure aux valeurs de committedDueDate chaque élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/committed_due_date
ID externe	Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/external_id Valeur par défaut : chaîne vide
Note	Tableau d’objets contenant des notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note:" [ { "text": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order
note.texte	Requis. Remarques/commentaires supplémentaires faits par le client lors de la commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/commentaires Valeur par défaut : chaîne vide
orderCurrency	Requis. Code de devise pour la commande et les éléments de ligne 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
Élément de commande produit	Requis. Tableau d’objets décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"productOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
Élément de commandeproduit.action	Requis. Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action
Élément de commandeproduit.actionReason	Facultatif. Description du motif de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/committed_due_date
productOrderItem.externalProductInventory	Tableau d’objets contenant des ID externes à mapper vers les inventaires de produits créés pour la commande. Type de données : tableau `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_inventory_id et sn_prd_invt_product_inventory/sn_prd_invt_external_id
productOrderItem.id	Requis. Identificateur unique de l’élément de ligne. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_id Longueur maximale : 40 Valeur par défaut : chaîne vide
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Table mise à jour : sn_ind_tmt_orm_order Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }` Table mise à jour : sn_ind_tmt_orm_order_line_item Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }` Table mise à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/mrc ou nrc
productOrderItem.itemPrice.price.taxIncludedAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/mrc ou nrc
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
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, spécifie la période de récurrence, par exemple `le mois`. Type de données : chaîne
productOrderItem.product	Requis en cas de productOrderItem.action changement/déconnexion. Description des détails de l’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" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Requis en cas de productOrderItem.action changement/déconnexion. 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
productOrderItem.product.place	Cartes des emplacements sur lesquels installer le produit. Type de données : objet `"place:" { "id": "String", "@type": "String" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.product.place.id	Requis. Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/emplacement
productOrderItem.product.place.@type	Fait partie de la norme TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Place`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/caractéristiques Valeur par défaut : chaîne vide
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Valeur par défaut : chaîne vide
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Valeur par défaut : chaîne vide
productOrderItem.product.productSpecification	Requis. Description de la spécification de produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Requis. Initial_version ou external_id de la spécification de 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 Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de 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 de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.version	External_version de la spécification de produit. Situé dans la table Spécification de 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.relatedParty	Tableau d’objets décrivant le rôle de partie lié à un OrderLineItemContact. Type de données : tableau `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/e-mail Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.firstName	Prénom du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/first_name Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/lastName 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/business_phone 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 TMF Open API. 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 TMF Open API. 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" }` Table mise à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Requis. Initial_version ou external_id de l’offre de produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItem.quantity	Nombre d’éléments associés à commander. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order/quantité Valeur par défaut : null
productOrderItem.productOrderItemRelationship	Requis. Tableau d’objets décrivant la relation parent/enfant entre les éléments de commande. Type de données : tableau `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Table/champ mis à jour : 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/parent_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 (en anglais seulement) HasParent Type de données : chaîne
produitCommandeArticle.quantité	Nombre d’éléments commandés. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order/quantité Valeur par défaut : chaîne vide
productOrderItem.@type	Fait partie de la norme TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte ou du contact du client 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	Requis. Type de client. Valeurs possibles : Consommateur Client Contact du client Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. 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 Table/champ mis à jour : sn_ind_tmt_orm_order/expected_end_date Valeur par défaut : chaîne vide
requestedStartDate (Date de début demandée)	Date de début de commande demandée par le client. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/expected_start_date Valeur par défaut : chaîne vide
@type	Fait partie de la norme TMF Open API. 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 une 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 informations sur les caractéristiques ou les options de caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs des notes de travail de l’enregistrement d’élément de ligne de commande client associé : `Les caractéristiques de l’article de commande suivantes n’existent pas : Examinez la spécification <characteristic.name> 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 de valider la commande.`
202	Accepté. Demande réussie pour une commande en mode asynchrone. C’est-à-dire que la demande a été effectuée avec le mode paramètre réglé sur `async` et que le traitement de l’enregistrement est planifié dans la table File d’attente entrante [sn_tmt_core_inbound_queue].
400	Demande incorrecte. Cela 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 :` l’objet ou le JSON de l’élément de ligne de commande de produit est manquant. `Charge utile non valide : l’ID de 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 ou le JSON de l’offre de produit 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 :` le id 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 de produit n’est pas valide. `Charge utile non valide : productOrderItem product est manquant :` l’objet produit ou JSON dans l’élément de ligne de commande de produit est manquant dans la charge utile. `Charge utile non valide : product productSpecification est manquant :` l’objet de spécification de produit ou 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 de produit est manquant :` le id paramètre dans 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 de produit n’existe pas` : la spécification de produit dans l’élément de ligne de commande de 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 product.id est manquant dans la charge utile. `Charge utile non valide : le produit vendu est inactif` : dans un ordre de modification, un produit spécifié dans la charge utile est inactif. `Charge utile non valide : relatedParty est manquant` : l’objet de la partie associée est manquant dans la charge utile. `Charge utile non valide : compte client ou consommateur manquant` : l’objet client ou consommateur partie connexe est manquant dans la charge utile. `Charge utile non valide : Le consommateur n’existe pas` : le consommateur de la partie associée spécifiée 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 : <currency>` : 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 la 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	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. 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 ultérieure aux valeurs de committedDueDate chaque élément de ligne de commande. Type de données : chaîne
ID externe	Identificateur externe de la commande client, tel qu’un numéro de bon de commande. Type de données : chaîne
href	Lien relatif à l’enregistrement de la commande de produit. Type de données : chaîne
ID	Sys_id de la commande client créée pour cette demande. Type de données : chaîne
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note:" [ { "text": "String" } ]`
note.texte	Remarques/commentaires supplémentaires faits 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 commande. Type de données : chaîne
orderId	Sys_id de la commande à créer. En cas de demande réussie, la commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] selon un calendrier à traiter. Remarque : Cette valeur est le seul résultat si la commande est créée de façon asynchrone à l’aide du paramètre de mode requête. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Type de données : chaîne
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
Élément de commandeproduit.action	Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions de la table sn_ind_tmt_orm_order_line_item. Type de données : chaîne
Élément de commandeproduit.actionReason	Motif de l’ajout de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de commande. Type de données : chaîne
productOrderItem.externalProductInventory	Tableau d’objets contenant des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire des 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
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne
productOrderItem.itemPrice.price.taxIncludeAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `le mois`. Type de données : chaîne
productOrderItem.product	Description des détails de l’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 est `modifié` ou `déconnecté.` Si sys_id et external_id sont présents, le external_id est renvoyé. Type de données : chaîne
productOrderItem.product.place	Cartes des emplacements sur lesquels installer le 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.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne
productOrderItem.product.productRelationship	Liste des détails sur la 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. Situé dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne
productOrderItem.product.productRelationship.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
productOrderItem.product.productSpecification	Description de la spécification de 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 de 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 Spécification de produit [sn_prd_pm_product_specification]. Si sys_id et external_id sont présents, le external_id est renvoyé. Type de données : chaîne
productOrderItem.product.productSpecification.internalId	Initial_version de la spécification de produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de 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 de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.version	External_version de la spécification de produit. Situé dans la table Spécification de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"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
productOrderItem.product.relatedParty.firstName	Prénom du contact. Type de données : chaîne
productOrderItem.product.relatedParty.lastName	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 TMF Open API. 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 TMF Open API. 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 produit. 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 produits [sn_prd_pm_product_offering]. Si sys_id et external_id sont présents, le external_id est renvoyé. Type de données : chaîne
productOrderItem.productOffering.internalId	Initial_version de l’offre de produit. Le initial_version est le sys_id de la première version de l’offre. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"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 (en anglais seulement) 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
produitCommandeArticle.quantité	Nombre d’é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 TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du 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 demandée)	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 TMF Open API. 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] selon 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",
          "recurringChargePeriod": "month",
          "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 pour la 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 Tokyo version, ce point de terminaison est déconseillé. La nouvelle version de ce point de terminaison est Ouvrir l’API de la 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 de l’é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
Néant

Tableau 51. Paramètres de corps de demande (JSON)
Nom	Description
canal	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order
channel.id	Requis. Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/canal 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 ultérieure aux valeurs de committedDueDate chaque élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/committed_due_date
ID externe	Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/external_id Valeur par défaut : chaîne vide
Note	Tableau d’objets contenant des notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note:" [ { "text": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order
note.texte	Requis. Remarques/commentaires supplémentaires faits par le client lors de la commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/commentaires Valeur par défaut : chaîne vide
orderCurrency	Requis. Code de devise pour la commande et les éléments de ligne 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
Élément de commande produit	Requis. Tableau d’objets décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"productOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
Élément de commandeproduit.action	Requis. Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action
Élément de commandeproduit.actionReason	Facultatif. Description du motif de l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/committed_due_date
productOrderItem.externalProductInventory	Tableau d’objets contenant des ID externes à mapper vers les inventaires de produits créés pour la commande. Type de données : tableau `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_inventory_id et sn_prd_invt_product_inventory/sn_prd_invt_external_id
productOrderItem.id	Requis. Identificateur unique de l’élément de ligne. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_id Longueur maximale : 40 Valeur par défaut : chaîne vide
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Table mise à jour : sn_ind_tmt_orm_order Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }` Table mise à jour : sn_ind_tmt_orm_order_line_item Valeur par défaut : chaîne vide
productOrderItem.itemPrice.price.taxIncludedAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }` Table mise à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/mrc ou nrc
productOrderItem.itemPrice.price.taxIncludedAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/mrc ou nrc
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
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, spécifie la période de récurrence, par exemple `le mois`. Type de données : chaîne
productOrderItem.product	Requis en cas de productOrderItem.action changement/déconnexion. Description des détails de l’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" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Requis en cas de productOrderItem.action changement/déconnexion. 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
productOrderItem.product.place	Cartes des emplacements sur lesquels installer le produit. Type de données : objet `"place:" { "id": "String", "@type": "String" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.product.place.id	Requis. Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/emplacement
productOrderItem.product.place.@type	Fait partie de la norme TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours `Place`. Ces informations ne sont pas stockées. Type de données : chaîne
productOrderItem.product.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/caractéristiques Valeur par défaut : chaîne vide
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Valeur par défaut : chaîne vide
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Valeur par défaut : chaîne vide
productOrderItem.product.productSpecification	Requis. Description de la spécification de produit associée au produit. Type de données : objet `"productSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Requis. Initial_version ou external_id de la spécification de 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 Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de 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 de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productOrderItem.product.productSpecification.version	External_version de la spécification de produit. Situé dans la table Spécification de 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.relatedParty	Tableau d’objets décrivant le rôle de partie lié à un OrderLineItemContact. Type de données : tableau `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/e-mail Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.firstName	Prénom du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/first_name Valeur par défaut : chaîne vide
productOrderItem.product.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/lastName 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item_contact/business_phone 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 TMF Open API. 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 TMF Open API. 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" }` Table mise à jour : sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Requis. Initial_version ou external_id de l’offre de produit. 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 produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.internalVersion	Version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOffering.version	External_version de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItem.quantity	Nombre d’éléments associés à commander. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order/quantité Valeur par défaut : null
productOrderItem.productOrderItemRelationship	Requis. Tableau d’objets décrivant la relation parent/enfant entre les éléments de commande. Type de données : tableau `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Table/champ mis à jour : 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 Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/parent_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 (en anglais seulement) HasParent Type de données : chaîne
produitCommandeArticle.quantité	Nombre d’éléments commandés. Type de données : nombre Table/champ mis à jour : sn_ind_tmt_orm_order/quantité Valeur par défaut : chaîne vide
productOrderItem.@type	Fait partie de la norme TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte ou du contact du client 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	Requis. Type de client. Valeurs possibles : Consommateur Client Contact du client Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. 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 Table/champ mis à jour : sn_ind_tmt_orm_order/expected_end_date Valeur par défaut : chaîne vide
requestedStartDate (Date de début demandée)	Date de début de commande demandée par le client. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order/expected_start_date Valeur par défaut : chaîne vide
@type	Fait partie de la norme TMF Open API. 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 une 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 informations sur les caractéristiques ou les options de caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs des notes de travail de l’enregistrement d’élément de ligne de commande client associé : `Les caractéristiques de l’article de commande suivantes n’existent pas : Examinez la spécification <characteristic.name> 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 de valider la commande.`
400	Demande incorrecte. Cela 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 :` l’objet ou le JSON de l’élément de ligne de commande de produit est manquant. `Charge utile non valide : l’ID de 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 ou le JSON de l’offre de produit 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 :` le id 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 de produit n’est pas valide. `Charge utile non valide : productOrderItem product est manquant :` l’objet produit ou JSON dans l’élément de ligne de commande de produit est manquant dans la charge utile. `Charge utile non valide : product productSpecification est manquant :` l’objet de spécification de produit ou 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 de produit est manquant :` le id paramètre dans 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 de produit n’existe pas` : la spécification de produit dans l’élément de ligne de commande de 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 product.id est manquant dans la charge utile. `Charge utile non valide : le produit vendu est inactif` : dans un ordre de modification, un produit spécifié dans la charge utile est inactif. `Charge utile non valide : relatedParty est manquant` : l’objet de la partie associée est manquant dans la charge utile. `Charge utile non valide : compte client ou consommateur manquant` : l’objet client ou consommateur partie connexe est manquant dans la charge utile. `Charge utile non valide : Le consommateur n’existe pas` : le consommateur de la partie associée spécifiée 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	Tableau d’objets décrivant les canaux à utiliser pour vendre les produits. Type de données : tableau `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Identificateur unique du canal à utiliser pour vendre les produits associés. Les valeurs d’ID de canal sont situées dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. 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 créée pour cette demande. Type de données : chaîne
ID externe	Identificateur externe de la commande client, tel qu’un numéro de bon de commande. Type de données : chaîne
Note	Tableau d’objets qui décrivent les notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note:" [ { "text": "String" } ]`
note.texte	Remarques/commentaires supplémentaires faits par le client lors de la commande. Type de données : chaîne
Élément de commande produit	Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau `"productOrderItem:" [ { "action": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
Élément de commandeproduit.action	Action à effectuer sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’actions 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 commande. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action_reason
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
productOrderItem.itemPrice	Tableau d’objets décrivant le prix associé au produit. Type de données : tableau `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Description du prix du produit associé. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Description du prix du produit associé, taxes comprises. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Code de devise dans lequel le prix est représenté. Type de données : chaîne
productOrderItem.itemPrice.price.taxIncludeAmount.value	Prix du produit, toutes taxes comprises. Type de données : nombre
productOrderItem.itemPrice.priceType	Type de prix de l’élément, récurrent ou non. Type de données : chaîne
productOrderItem.itemPrice.recurringChargePeriod	Si le prix est récurrent, la période de récurrence, telle que `le mois`. Type de données : chaîne
productOrderItem.product	Description des détails de l’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 est `modifié` ou `déconnecté.` Si sys_id et external_id sont présents, le external_id est renvoyé. Type de données : chaîne
productOrderItem.product.place	Cartes des emplacements sur lesquels installer le 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.productCharacteristics	Tableau d’objets décrivant les caractéristiques du produit associé. Type de données : tableau `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Nom de l’enregistrement de caractéristique à associer à l’article. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
productOrderItem.product.productCharacteristic.previousValue	Valeurs d’option de caractéristique précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le productOrderItem.action paramètre est autre que `ajouter`. Type de données : chaîne
productOrderItem.product.productCharacteristic.value	Valeurs d’option caractéristique associées à l’article. Type de données : chaîne
productOrderItem.product.productSpecification	Description de la spécification de 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 de 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 Spécification de produit [sn_prd_pm_product_specification]. Si sys_id et external_id sont présents, le external_id est renvoyé. Type de données : chaîne
productOrderItem.product.productSpecification.name	Nom de la spécification de produit. Situé dans la table Spécification de 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.relatedParty	Liste des contacts pour les éléments de ligne. Type de données : tableau `"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
productOrderItem.product.relatedParty.firstName	Prénom du contact. Type de données : chaîne
productOrderItem.product.relatedParty.lastName	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 TMF Open API. 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 TMF Open API. 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 produit. 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 produits [sn_prd_pm_product_offering]. Si sys_id et external_id sont présents, le external_id est renvoyé. Type de données : chaîne
productOrderItem.productOffering.name	Nom de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
productOrderItem.productOrderItemRelationship	Tableau d’objets qui décrivent les relations entre les éléments de ligne de commande. Type de données : tableau `"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
produitCommandeArticle.quantité	Nombre d’é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 TMF Open API. Annotation pour le produit. Cette valeur est toujours `ProductOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty	Liste des contacts de la commande. Chaque contact est un objet du tableau. Doit répertorier au moins un élément qui contient des informations sur le compte client ou le compte de consommateur. Type de données : tableau `"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 du 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 demandée)	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 TMF Open API. 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",
            "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",
            "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",
                        "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",
                        "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"
}