API ouverte de la commande de produit
L’API Commande de produit ouverte fournit des points de terminaison qui activent un mécanisme standardisé pour passer des commandes de produits.
Une commande de produit est créée en fonction d’une offre de produit définie et publiée dans un catalogue de produits. L’offre de produit identifie le produit ou l’ensemble de produits qui sont disponibles pour un client et inclut les caractéristiques pertinentes du produit qui capturent les options uniques d’un produit, ainsi que d’autres attributs pertinents tels que le prix, les conditions contractuelles et la disponibilité.
Pour accéder à cette API, le (sn_ind_tmt_orm) module d’extension Order Management for Telecommunications doit être activé. Pour plus d'informations, consultez Install Order Management . Pour en savoir plus sur les tables et les Gestion des commandes rôles, reportez-vous à la section Components installed with Order Management.
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, consultez le Product Order Open API Developer Guide.
L’API ouverte de commande de produit est une ServiceNow® implémentation de la spécification API de gestion des commandes de produits TM Forum. Cette implémentation est basée sur le Guide de l’utilisateur de l’API de gestion des commandes de produits TMF622 v5.0.0, septembre 2024. L’API ouverte de commande de produit est certifiée de conformité par TM Forum.
API ouverte de commande de produit : GET /sn_ind_tmt_orm/order/productOrder
Récupère toutes les commandes de produits.
Ce point de terminaison récupère les informations de commande à partir des tables suivantes :
- Commande de clients [sn_ind_tmt_orm_order]
- Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
- Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
- Contact 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
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : tous les champs renvoyés. |
| limite | Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement offset . Type de données : nombre Par défaut : 20 Maximum : 100 |
| décalage | Index de départ sur lequel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Type de données : nombre Par défaut : 0 |
| État | Filtrer les commandes par état. Seules les commandes dont l’état correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne Par défaut : ne pas trier par état. |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Néant |
| En-tête | Description |
|---|---|
| Plage de contenu | Plage de contenu renvoyé dans un appel paginé. Par exemple, si |
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| un lien | Contient les liens suivants pour parcourir les résultats de la requête.
|
| Nombre X-Total | Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur. |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination). |
| 206 | Ressource partielle renvoyée en réponse (avec pagination). |
| 400 | Demande incorrecte. Raisons possibles :
|
| 404 | Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Liste des canaux à utiliser pour vendre les produits.
Type de données : tableau d’objets |
| channel.id | Identificateur unique du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| channel.name | Nom du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| committedDueDate | Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque élément de ligne de committedDueDate bon de commande. Type de données : chaîne |
| Date d’achèvement attendue | 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 |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets |
| note.auteur | Nom d’utilisateur de la personne auteur de 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 | Notes/commentaires supplémentaires effectués par le client lors de la commande.
Type de données : chaîne |
| orderCurrency | Code de devise pour la commande et les éléments de ligne de bon de commande. Type de données : chaîne |
| PONR | Marqueur indiquant si le point de non retour de la commande a été atteint. Valeurs possibles :
Type de données : booléennes |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets |
| produitÉlémentCommande.action | Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item.
Type de données : chaîne |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne |
| produitÉlémentCommande.InventaireProduitexterne | Liste des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau d’objets |
| 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 | Liste décrivant le prix associé au produit.
Type de données : tableau d’objets |
| productOrderItem.itemPrice.price | Description du prix du produit associé.
Type de données : objet |
| productOrderItem.itemPrice.price.taxIncludedAmount | Description du prix du produit associé, taxes comprises.
Type de données : objet |
| 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, taxe comprise.
Type de données : nombre |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent.
Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois.
Type de données : chaîne |
| produitÉlémentCommande.ponr | Marqueur indiquant si le point de non retour de la commande a été atteint. Valeurs possibles :
Type de données : booléennes |
| produitÉlémentCommande.produit | Description des détails d’instance du produit acheté par le client. Type de données : objet |
| productOrderItem.product.place | Cartes des emplacements d’installation du produit.
Type de données : objet |
| productOrderItem.product.place.id | Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement.
Type de données : chaîne |
| productOrderItem.product.place.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours Lieu. Ces informations ne sont pas stockées.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé. Seules les caractéristiques du produit différentes de celles previousValue qui value sont renvoyées. Type de données : tableau d’objets |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic].
Type de données : chaîne |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| productItemOrder.product.productCharacteristic.valueType | Type de valeur caractéristique. Valeurs possibles :
Type de données : chaîne |
| productOrderItem.product.productRelationship | Liste des détails des relations de produits pour un élément de ligne de commande. Type de données : tableau d’objets |
| productOrderItem.product.productRelationship.id | Sys_id ou sn_prd_invt_external_id de l’inventaire des produits. Type de données : chaîne Table : dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. |
| 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 |
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit. Type de données : objet |
| productOrderItem.product.productSpecification.id | Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de produit [sn_prd_pm_product_specification].
Type de données : chaîne |
| productOrderItem.product.productSpecification.internalId | Version initiale du cahier des charges. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Situé dans la table Product Specification (Spécification de produit) [sn_prd_pm_product_specification].
Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées. Type de données : chaîne |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.id | Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact].
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact.
Type de données : chaîne Type de données : chaîne |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.@referredType | Type de client.
Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit. Type de données : objet |
| productOrderItem.productOffering.id | Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.internalId | Version initiale de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.internalVersion | Version de l’offre de produits. Type de données : chaîne Table : table Offre de produits [sn_prd_pm_product_offering], version du champ. |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.version | Version externe de l’offre de produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering]. |
| productOrderItem.quantity | Nombre d’éléments de produit achetés. Type de données : nombre |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande.
Type de données : tableau d’objets |
| 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 et HasParent sont utilisés pour les relations parent/enfant. Exige est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne).Type de données : chaîne |
| productOrderItem.state | État de la commande de l’élément de produit associé. Type de données : chaîne |
| produitÉlémentCommande.version | Version de la commande. Type de données : chaîne |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur. Type de données : tableau d’objets |
| relatedParty.id | Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Ils se trouvent 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 :
Type de données : chaîne |
| relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client.
Type de données : chaîne |
| requestedStartDate | Date de début de commande demandée par le client.
Type de données : chaîne |
| État | État actuel de la commande. Type de données : chaîne |
| version | Version de la commande. Type de données : chaîne |
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
Demande cURL
Cet exemple récupère toutes les commandes de produits.
curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder' \
--user 'username':'password'Corps de la réponse.
[
{
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"orderCurrency": "USD",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "v1",
"internalVersion": "1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "v1",
"internalVersion": "1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "v1",
"internalVersion": "1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI110",
"relationshipType": "Requires"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "v1",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
]API ouverte de commande de produit : GET /sn_ind_tmt_orm/productorder
Récupère toutes les commandes de produits.
Important :
Ce point de terminaison est obsolète depuis la Tokyo mise en production. La nouvelle version de ce point de terminaison est API ouverte de commande de produit : GET /sn_ind_tmt_orm/order/productOrder.
Ce point de terminaison récupère les informations de commande à partir des tables suivantes :
- Commande de clients [sn_ind_tmt_orm_order]
- Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
- Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
- Contact 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
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : tous les champs renvoyés. |
| limite | Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement offset . Type de données : nombre Par défaut : 20 Maximum : 100 |
| décalage | Index de départ sur lequel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Type de données : nombre Par défaut : 0 |
| État | Filtrer les commandes par état. Seules les commandes dont l’état correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne Par défaut : tous les états renvoyés. |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Néant |
| En-tête | Description |
|---|---|
| Plage de contenu | Plage de contenu renvoyé dans un appel paginé. Par exemple, si |
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| un lien | Contient les liens suivants pour parcourir les résultats de la requête.
|
| Nombre X-Total | Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur. |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination). |
| 206 | Ressource partielle renvoyée en réponse (avec pagination). |
| 400 | Demande incorrecte. Raisons possibles :
|
| 404 | Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Liste des canaux à utiliser pour vendre les produits.
Type de données : tableau d’objets |
| channel.id | Identificateur unique du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| channel.name | Nom du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| Date d’achèvement attendue | Date à laquelle la commande sera terminée. Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets |
| note.auteur | Nom d’utilisateur de la personne auteur de 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 | Notes/commentaires supplémentaires effectués par le client lors de la commande.
Type de données : chaîne |
| PONR | Marqueur indiquant si le point de non retour de la commande a été atteint. Valeurs possibles :
Type de données : booléennes |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets |
| produitÉlémentCommande.action | Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item.
Type de données : chaîne |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.id | Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
Type de données : chaîne |
| productOrderItem.itemPrice | Liste décrivant le prix associé au produit.
Type de données : tableau d’objets |
| productOrderItem.itemPrice.price | Description du prix du produit associé.
Type de données : objet |
| productOrderItem.itemPrice.price.taxIncludedAmount | Description du prix du produit associé, taxes comprises.
Type de données : objet |
| 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, taxe comprise.
Type de données : nombre |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent.
Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois.
Type de données : chaîne |
| produitÉlémentCommande.ponr | Marqueur indiquant si le point de non retour de la commande a été atteint. Valeurs possibles :
Type de données : booléennes |
| produitÉlémentCommande.produit | Description des détails d’instance du produit acheté par le client. Type de données : objet |
| productOrderItem.product.place | Cartes des emplacements d’installation du produit.
Type de données : objet |
| productOrderItem.product.place.id | Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement.
Type de données : chaîne |
| productOrderItem.product.place.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours Lieu. Ces informations ne sont pas stockées.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé. Seules les caractéristiques du produit différentes de celles previousValue qui value sont renvoyées. Type de données : tableau d’objets |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic].
Type de données : chaîne |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| productItemOrder.product.productCharacteristic.valueType | Type de valeur caractéristique. Valeurs possibles :
Type de données : chaîne |
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit. Type de données : objet |
| productOrderItem.product.productSpecification.id | Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications 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 Product Specification (Spécification de produit) [sn_prd_pm_product_specification].
Type de données : chaîne |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées. Type de données : chaîne |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.id | Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact].
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact.
Type de données : chaîne Type de données : chaîne |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.@referredType | Type de client.
Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit.
Type de données : objet |
| productOrderItem.productOffering.id | Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.quantity | Nombre d’éléments de produit achetés. Type de données : nombre |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande.
Type de données : tableau d’objets |
| 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 et HasParent sont utilisés pour les relations parent/enfant. Exige est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne).Type de données : chaîne |
| productOrderItem.state | État de la commande de l’élément de produit associé. Type de données : chaîne |
| produitÉlémentCommande.version | Version de la commande. Type de données : chaîne |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur. Type de données : tableau d’objets |
| relatedParty.id | Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Ils se trouvent 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 :
Type de données : chaîne |
| relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client.
Type de données : chaîne |
| requestedStartDate | Date de début de commande demandée par le client.
Type de données : chaîne |
| État | État actuel de la commande. Type de données : chaîne |
| version | Version de la commande. Type de données : chaîne |
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
Demande cURL
Cet exemple récupère toutes les commandes de produits.
curl --location --request GET 'https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder' \
--user 'username':'password'
Corps de la réponse.
[
{
"id": "8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
]API ouverte de la commande de produit : GET /sn_ind_tmt_orm/productorder/{id}
Récupère la commande de produits spécifiée.
Important :
Ce point de terminaison est obsolète depuis la Tokyo mise en production. La nouvelle version de ce point de terminaison est API ouverte de la commande de produit : GET /sn_ind_tmt_orm/productorder/{id}.
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
| Nom | Description |
|---|---|
| id | Sys_id ou external_id de la commande du client à récupérer. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Néant |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Cela peut être dû à l’une des raisons suivantes :
|
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Liste des canaux à utiliser pour vendre les produits.
Type de données : tableau d’objets |
| channel.id | Identificateur unique du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| channel.name | Nom du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| Date d’achèvement attendue | Date à laquelle la commande sera terminée. Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande. Type de données : objet |
| note.auteur | Nom d’utilisateur de la personne auteur de 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 | Notes/commentaires supplémentaires effectués par le client lors de la commande.
Type de données : chaîne |
| PONR | Marqueur indiquant si le point de non retour de la commande a été atteint. Valeurs possibles :
Type de données : booléennes |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets |
| produitÉlémentCommande.action | Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item.
Type de données : chaîne |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.id | Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
Type de données : chaîne |
| productOrderItem.itemPrice | Liste décrivant le prix associé au produit.
Type de données : tableau d’objets |
| productOrderItem.itemPrice.price | Description du prix du produit associé.
Type de données : objet |
| productOrderItem.itemPrice.price.taxIncludedAmount | Description du prix du produit associé, taxes comprises.
Type de données : objet |
| 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, taxe comprise.
Type de données : nombre |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent.
Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois.
Type de données : chaîne |
| produitÉlémentCommande.ponr | Marqueur indiquant si le point de non retour de la commande a été atteint. Valeurs possibles :
Type de données : booléennes |
| produitÉlémentCommande.produit | Description des détails d’instance du produit acheté par le client. Type de données : objet |
| productOrderItem.product.place | Cartes des emplacements d’installation du produit.
Type de données : objet |
| productOrderItem.product.place.id | Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement.
Type de données : chaîne |
| productOrderItem.product.place.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours Lieu. Ces informations ne sont pas stockées.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé. Seules les caractéristiques du produit différentes de celles previousValue qui value sont renvoyées. Type de données : tableau d’objets |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic].
Type de données : chaîne |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| productItemOrder.product.productCharacteristic.valueType | Type de valeur caractéristique. Valeurs possibles :
Type de données : chaîne |
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit. Type de données : objet |
| productOrderItem.product.productSpecification.id | Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications 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 Product Specification (Spécification de produit) [sn_prd_pm_product_specification].
Type de données : chaîne |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées. Type de données : chaîne |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne. Type de données : objet |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.id | Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact].
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.@referredType | Type de client.
Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit.
Type de données : objet |
| productOrderItem.productOffering.id | Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.quantity | Nombre d’éléments de produit achetés. Type de données : nombre |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande.
Type de données : tableau d’objets |
| 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 et HasParent sont utilisés pour les relations parent/enfant. Exige est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne).Type de données : chaîne |
| productOrderItem.state | État de la commande de l’élément de produit associé. Type de données : chaîne |
| produitÉlémentCommande.version | Version de la commande. Type de données : chaîne |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur. Type de données : tableau d’objets |
| relatedParty.id | Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Ils se trouvent 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 :
Type de données : chaîne |
| relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client.
Type de données : chaîne |
| requestedStartDate | Date de début de commande demandée par le client.
Type de données : chaîne |
| État | État actuel de la commande. Type de données : chaîne |
| version | Version de la commande. Type de données : chaîne |
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
Demande cURL
L’exemple de code suivant demande une commande client existante.
curl -X GET "https://servicenow-instance/api/sn_ind_tmt_orm/productorder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"
Corps de la réponse.
{
"id": "8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}API ouverte de commande de produit : GET /sn_ind_tmt_orm/order/productOrder/{id}
Met à jour la commande de clients 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
| Nom | Description |
|---|---|
| id | Sys_id de la commande de client à mettre à jour. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
| canal | Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order |
| channel.id | Requis si le channel paramètre est utilisé. Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne Table : dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Stocké dans : champ Canal de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| channel.name | Nom du canal à utiliser pour vendre les produits associés. Les noms de canaux possibles sont définis dans l’onglet Liste de choix de l’entrée du dictionnaire des canaux de la table sn_ind_tmt_orm_order. Type de données : chaîne Valeur par défaut : chaîne vide |
| committedDueDate | Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque élément de ligne de committedDueDate bon de commande. Si l’action pour les éléments de ligne de commande est suspendre ou reprendre, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : champ committed_due_date de la table sn_ind_tmt_orm_order. |
| externalId | Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| Système externe | Système externe de l’ordre de service, accompagné du TMF622. Par exemple, si le système externe est ABC, saisissez la valeur externalSystem Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order |
| note.texte | Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| orderCurrency | Code de devise pour la commande et les éléments de ligne de bon de commande. La mise à jour du code de devise d’une commande existante n’est pas prise en charge. La fourniture d’une valeur autre que le code de devise déjà associé à la commande entraîne le rejet de la mise à jour. Type de données : chaîne |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| produitÉlémentCommande.action | Requis si le productOrderItem paramètre est utilisé. Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles :
Type de données : chaîne Stocké dans : champ d’action de la table sn_ind_tmt_orm_order_line_item. Par défaut : ajouter |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Si l’action de l’élément est suspendre ou reprendre, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : champ committed_due_date de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.externalProductInventory.externalProductInventoryId | ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : le champ external_inventory_id de la table sn_ind_tmt_orm_order_line_item et le champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory. |
| produitÉlémentCommande.InventaireProduitexterne | Liste des ID externes à mapper aux inventaires des produits créés pour la commande. Type de données : tableau d’objets Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée. |
| productOrderItem.id | Requis si le productOrderItem paramètre est utilisé. Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order_line_item. Longueur maximale : 40 Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice | Liste décrivant le prix associé au produit. Type de données : tableau d’objets Stocké dans : 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 Stocké dans : sn_ind_tmt_orm_order_line_item Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice.price.taxIncludedAmount | Description du prix du produit associé, taxes comprises. Type de données : objet Stocké dans : 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 Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Prix du produit, taxe comprise. Type de données : nombre Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois. Type de données : chaîne |
| produitÉlémentCommande.produit | Requis si productOrderItem.action est modifié ou supprimé. Description des détails d’instance du produit acheté par le client. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.id | Requis si productOrderItem.action est modifié ou supprimé. 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 |
| produitÉlémentCommande.produit.place | Cartes des emplacements d’installation du produit. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.place.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours Lieu. Ces informations ne sont pas stockées. Type de données : chaîne |
| 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]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement. Type de données : chaîne Stocké dans : champ d’emplacement de la table sn_ind_tmt_orm_order_line_item. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne Stocké dans : Le champ des caractéristiques de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : previous_characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : champ characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| productItemOrder.product.productCharacteristic.valueType | Type de valeur caractéristique. Type de données : chaîne Valeurs possibles :
|
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit. Remarque :
Les ordres de changement (productOrderItem.action est un changement) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. La valeur de cette propriété système détermine le mode de traitement de la commande si la version de l’inventaire des produits est différente de celle indiquée dans la commande.
Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.productSpecification.id | Requis si le productOrderItem.product.productSpecification paramètre est utilisé. Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version interne du cahier des charges. Doit correspondre à la valeur de version sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Situé dans la table Product Specification (Spécification de produit) [sn_prd_pm_product_specification]. Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Doit correspondre à la valeur de internalVersion sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.@referredType | Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact. Type de données : chaîne Stocké dans : champ d’e-mail de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact. Type de données : chaîne Stocké dans : champ first_name de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.product.relatedParty.id | Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne Stocké dans : champ sys_id de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact. Type de données : chaîne Stocké dans : champ lastName de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.Partieconnexe.téléphone | Numéro de téléphone professionnel du contact. Type de données : chaîne Stocké dans : champ business_phone de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | Requis si le productOrderItem.productOffering paramètre est utilisé. Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOrderItem.productOffering.internalVersion | Version de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOrderItem.productOffering.version | External_version de l’offre de produit. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOrderItem.quantity | Nombre d’éléments associés à commander. Type de données : nombre Stocké dans : champ Quantité du sn_ind_tmt_orm_order. Valeur par défaut : null |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | Requis si le productOrderItem.productOrderItemRelationship paramètre est utilisé. Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : champ parent_line_item de thebsn_ind_tmt_orm_order_line_item table. Valeur par défaut : chaîne vide |
| productOrderItem.productOrderItemRelationship.relationshipType | Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles :
HasChild et HasParent sont utilisés pour les relations parent/enfant. Exige est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne).Type de données : chaîne |
| productOrderItem.quantity | Nombre d’éléments commandés. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| productOrderItem.revisionOperation | Type de mise à jour à effectuer sur l’élément de ligne. Si cette valeur est vide, l’élément de ligne existant est mis à jour ou un nouvel élément de ligne est ajouté s’il n’existe pas déjà. Si cette valeur est Annuler, l’élément de ligne est annulé. Type de données : chaîne Valeur par défaut : chaîne vide |
| Fête connexe | |
| relatedParty.@referredType | |
| relatedParty.@type | |
| relatedParty.id | |
| relatedParty.name | |
| requestedCompletionDate | Date de livraison demandée par le client. Type de données : chaîne Stocké dans : champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| requestedStartDate | Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Réussi. En cas de problème avec les caractéristiques ou les informations d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé :
|
| 400 | Demande incorrecte. Peut être l’une des raisons suivantes :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Liste des canaux à utiliser pour vendre les produits.
Type de données : tableau d’objets |
| channel.id | Identificateur unique du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| channel.name | Nom du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| committedDueDate |
Date et heure auxquelles l’action doit être effectuée sur la commande.
Cette valeur doit être identique ou postérieure aux valeurs de chaque élément de ligne de committedDueDate bon de commande. Type de données : chaîne |
| externalId | 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 de clients mise à jour pour cette demande. Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande.
Type de données : tableau d’objets |
| note.texte | Notes/commentaires supplémentaires effectués par le client lors de la commande.
Type de données : chaîne |
| orderCurrency | Code de devise pour la commande et les éléments de ligne de bon de commande. Type de données : chaîne |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets |
| produitÉlémentCommande.action | Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item.
Type de données : chaîne |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate |
Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande.
Type de données : chaîne |
| produitÉlémentCommande.InventaireProduitexterne | Liste des ID externes à mapper aux inventaires des produits créés pour la commande. Type de données : tableau d’objets Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée. |
| productOrderItem.externalProductInventory.externalProductInventoryId | ID externe mappé à l’inventaire 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 | Liste décrivant le prix associé au produit.
Type de données : tableau d’objets |
| productOrderItem.itemPrice.price | Description du prix du produit associé.
Type de données : objet |
| productOrderItem.itemPrice.price.taxIncludeAmount | Description du prix du produit associé, taxes comprises.
Type de données : objet |
| 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, taxe comprise.
Type de données : nombre |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent.
Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois.
Type de données : chaîne |
| produitÉlémentCommande.produit | Description des détails d’instance du produit acheté par le client.
Type de données : objet |
| productOrderItem.product.id | Identificateur unique du produit vendu. Situé dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory].
Type de données : chaîne |
| productOrderItem.product.place | Cartes des emplacements d’installation du produit.
Type de données : objet |
| productOrderItem.product.place.id | Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé. Type de données : tableau d’objets |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic].
Type de données : chaîne |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit. Type de données : objet |
| productOrderItem.product.productSpecification.id | Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de produit [sn_prd_pm_product_specification].
Type de données : chaîne |
| productOrderItem.product.productSpecification.internalId | Version initiale du cahier des charges. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Situé dans la table Product Specification (Spécification de produit) [sn_prd_pm_product_specification].
Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées.
Type de données : chaîne |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne.
Type de données : tableau d’objets |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.id | Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact].
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.@referredType | Type de client.
Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit. Type de données : objet |
| productOrderItem.productOffering.id | Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.internalId | Version initiale de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.internalVersion | Version de l’offre de produits. Type de données : chaîne Table : table Offre de produits [sn_prd_pm_product_offering], version du champ. |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.version | Version externe de l’offre de produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering]. |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande.
Type de données : tableau d’objets |
| productOrderItem.productOrderItemRelationship.id | Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
Type de données : chaîne |
| productOrderItem.productOrderItemRelationship.relationshipType | Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations.
Type de données : chaîne |
| productOrderItem.quantity | Nombre 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 d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur.
Type de données : tableau d’objets |
| relatedParty.id | Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Ils se trouvent 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 :
Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client.
Type de données : chaîne |
| requestedStartDate | Date de début de commande demandée par le client.
Type de données : chaîne |
| État | État actuel de la commande. Type de données : chaîne |
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
Demande cURL
Cet exemple récupère la commande de produit donnée associée à l’ID 8d75939453126010a795ddeeff7b126a.
curl -X GET "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 la commande de produit : PATCH /sn_ind_tmt_orm/order/productOrder/{id}
Met à jour la commande de clients 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
| Nom | Description |
|---|---|
| id | Sys_id de la commande de client à mettre à jour. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
| canal | Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order |
| channel.id | Requis si le channel paramètre est utilisé. Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne Table : dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Stocké dans : champ Canal de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| channel.name | Nom du canal à utiliser pour vendre les produits associés. Les noms de canaux possibles sont définis dans l’onglet Liste de choix de l’entrée du dictionnaire des canaux de la table sn_ind_tmt_orm_order. Type de données : chaîne Valeur par défaut : chaîne vide |
| committedDueDate | Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque élément de ligne de committedDueDate bon de commande. Si l’action pour les éléments de ligne de commande est suspendre ou reprendre, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : champ committed_due_date de la table sn_ind_tmt_orm_order. |
| externalId | Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| Système externe | Système externe de l’ordre de service, accompagné du TMF622. Par exemple, si le système externe est ABC, saisissez la valeur externalSystem Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order |
| note.texte | Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| orderCurrency | Code de devise pour la commande et les éléments de ligne de bon de commande. La mise à jour du code de devise d’une commande existante n’est pas prise en charge. La fourniture d’une valeur autre que le code de devise déjà associé à la commande entraîne le rejet de la mise à jour. Type de données : chaîne |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| produitÉlémentCommande.action | Requis si le productOrderItem paramètre est utilisé. Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles :
Type de données : chaîne Stocké dans : champ d’action de la table sn_ind_tmt_orm_order_line_item. Par défaut : ajouter |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Si l’action de l’élément est suspendre ou reprendre, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : champ committed_due_date de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.externalProductInventory.externalProductInventoryId | ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : le champ external_inventory_id de la table sn_ind_tmt_orm_order_line_item et le champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory. |
| produitÉlémentCommande.InventaireProduitexterne | Liste des ID externes à mapper aux inventaires des produits créés pour la commande. Type de données : tableau d’objets Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée. |
| productOrderItem.id | Requis si le productOrderItem paramètre est utilisé. Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order_line_item. Longueur maximale : 40 Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice | Liste décrivant le prix associé au produit. Type de données : tableau d’objets Stocké dans : 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 Stocké dans : sn_ind_tmt_orm_order_line_item Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice.price.taxIncludedAmount | Description du prix du produit associé, taxes comprises. Type de données : objet Stocké dans : 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 Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Prix du produit, taxe comprise. Type de données : nombre Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois. Type de données : chaîne |
| produitÉlémentCommande.produit | Requis si productOrderItem.action est modifié ou supprimé. Description des détails d’instance du produit acheté par le client. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.id | Requis si productOrderItem.action est modifié ou supprimé. 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 |
| produitÉlémentCommande.produit.place | Cartes des emplacements d’installation du produit. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.place.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours Lieu. Ces informations ne sont pas stockées. Type de données : chaîne |
| 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]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement. Type de données : chaîne Stocké dans : champ d’emplacement de la table sn_ind_tmt_orm_order_line_item. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne Stocké dans : Le champ des caractéristiques de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : previous_characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : champ characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| productItemOrder.product.productCharacteristic.valueType | Type de valeur caractéristique. Type de données : chaîne Valeurs possibles :
|
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit. Remarque :
Les ordres de changement (productOrderItem.action est un changement) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. La valeur de cette propriété système détermine le mode de traitement de la commande si la version de l’inventaire des produits est différente de celle indiquée dans la commande.
Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.productSpecification.id | Requis si le productOrderItem.product.productSpecification paramètre est utilisé. Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version interne du cahier des charges. Doit correspondre à la valeur de version sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Situé dans la table Product Specification (Spécification de produit) [sn_prd_pm_product_specification]. Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Doit correspondre à la valeur de internalVersion sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.@referredType | Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact. Type de données : chaîne Stocké dans : champ d’e-mail de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact. Type de données : chaîne Stocké dans : champ first_name de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.product.relatedParty.id | Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne Stocké dans : champ sys_id de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact. Type de données : chaîne Stocké dans : champ lastName de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.Partieconnexe.téléphone | Numéro de téléphone professionnel du contact. Type de données : chaîne Stocké dans : champ business_phone de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | Requis si le productOrderItem.productOffering paramètre est utilisé. Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOrderItem.productOffering.internalVersion | Version de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOrderItem.productOffering.version | External_version de l’offre de produit. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOrderItem.quantity | Nombre d’éléments associés à commander. Type de données : nombre Stocké dans : champ Quantité du sn_ind_tmt_orm_order. Valeur par défaut : null |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | Requis si le productOrderItem.productOrderItemRelationship paramètre est utilisé. Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : champ parent_line_item de thebsn_ind_tmt_orm_order_line_item table. Valeur par défaut : chaîne vide |
| productOrderItem.productOrderItemRelationship.relationshipType | Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles :
HasChild et HasParent sont utilisés pour les relations parent/enfant. Exige est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne).Type de données : chaîne |
| productOrderItem.quantity | Nombre d’éléments commandés. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| productOrderItem.revisionOperation | Type de mise à jour à effectuer sur l’élément de ligne. Si cette valeur est vide, l’élément de ligne existant est mis à jour ou un nouvel élément de ligne est ajouté s’il n’existe pas déjà. Si cette valeur est Annuler, l’élément de ligne est annulé. Type de données : chaîne Valeur par défaut : chaîne vide |
| Fête connexe | |
| relatedParty.@referredType | |
| relatedParty.@type | |
| relatedParty.id | |
| relatedParty.name | |
| requestedCompletionDate | Date de livraison demandée par le client. Type de données : chaîne Stocké dans : champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| requestedStartDate | Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Réussi. En cas de problème avec les caractéristiques ou les informations d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé :
|
| 400 | Demande incorrecte. Peut être l’une des raisons suivantes :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Liste des canaux à utiliser pour vendre les produits.
Type de données : tableau d’objets |
| channel.id | Identificateur unique du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| channel.name | Nom du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| committedDueDate | Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque élément de ligne de committedDueDate bon de commande. Type de données : chaîne |
| externalId | 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 de clients mise à jour pour cette demande. Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande.
Type de données : tableau d’objets |
| note.texte | Notes/commentaires supplémentaires effectués par le client lors de la commande.
Type de données : chaîne |
| orderCurrency | Code de devise pour la commande et les éléments de ligne de bon de commande. Type de données : chaîne |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets |
| produitÉlémentCommande.action | Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item.
Type de données : chaîne |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne |
| produitÉlémentCommande.InventaireProduitexterne | Liste des ID externes à mapper aux inventaires des produits créés pour la commande. Type de données : tableau d’objets Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée. |
| productOrderItem.externalProductInventory.externalProductInventoryId | ID externe mappé à l’inventaire 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 | Liste décrivant le prix associé au produit.
Type de données : tableau d’objets |
| productOrderItem.itemPrice.price | Description du prix du produit associé.
Type de données : objet |
| productOrderItem.itemPrice.price.taxIncludeAmount | Description du prix du produit associé, taxes comprises.
Type de données : objet |
| 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, taxe comprise.
Type de données : nombre |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent.
Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois.
Type de données : chaîne |
| produitÉlémentCommande.produit | Description des détails d’instance du produit acheté par le client.
Type de données : objet |
| productOrderItem.product.id | Identificateur unique du produit vendu. Situé dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory].
Type de données : chaîne |
| productOrderItem.product.place | Cartes des emplacements d’installation du produit.
Type de données : objet |
| productOrderItem.product.place.id | Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé. Type de données : tableau d’objets |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic].
Type de données : chaîne |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit. Type de données : objet |
| productOrderItem.product.productSpecification.id | Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de produit [sn_prd_pm_product_specification].
Type de données : chaîne |
| productOrderItem.product.productSpecification.internalId | Version initiale du cahier des charges. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Situé dans la table Product Specification (Spécification de produit) [sn_prd_pm_product_specification].
Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées.
Type de données : chaîne |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne.
Type de données : tableau d’objets |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.id | Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact].
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.@referredType | Type de client.
Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit. Type de données : objet |
| productOrderItem.productOffering.id | Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.internalId | Version initiale de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.internalVersion | Version de l’offre de produits. Type de données : chaîne Table : table Offre de produits [sn_prd_pm_product_offering], version du champ. |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.version | Version externe de l’offre de produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering]. |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande.
Type de données : tableau d’objets |
| productOrderItem.productOrderItemRelationship.id | Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
Type de données : chaîne |
| productOrderItem.productOrderItemRelationship.relationshipType | Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations.
Type de données : chaîne |
| productOrderItem.quantity | Nombre 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 d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur.
Type de données : tableau d’objets |
| relatedParty.id | Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Ils se trouvent 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 :
Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client.
Type de données : chaîne |
| requestedStartDate | Date de début de commande demandée par le client.
Type de données : chaîne |
| État | État actuel de la commande. Type de données : chaîne |
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
Demande cURL
Cet exemple met à jour le canal 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 clients spécifiée.
Important :
Ce point de terminaison est obsolète depuis la Tokyo mise en production. La nouvelle version de ce point de terminaison est API ouverte de la 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
| Nom | Description |
|---|---|
| id | Sys_id de la commande de client à mettre à jour. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
| canal | Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order |
| channel.id | Requis si le channel paramètre est utilisé. Identificateur unique du canal à utiliser pour vendre les produits associés. Type de données : chaîne Table : dans le champ external_id de la table Canal de distribution [sn_prd_pm_distribution_channel]. Stocké dans : champ Canal de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| channel.name | Nom du canal à utiliser pour vendre les produits associés. Les noms de canaux possibles sont définis dans l’onglet Liste de choix de l’entrée du dictionnaire des canaux de la table sn_ind_tmt_orm_order. Type de données : chaîne Valeur par défaut : chaîne vide |
| committedDueDate | Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque élément de ligne de committedDueDate bon de commande. Si l’action pour les éléments de ligne de commande est suspendre ou reprendre, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : champ committed_due_date de la table sn_ind_tmt_orm_order. |
| externalId | Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| Système externe | Système externe de l’ordre de service, accompagné du TMF622. Par exemple, si le système externe est ABC, saisissez la valeur externalSystem Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order |
| note.texte | Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| orderCurrency | Code de devise pour la commande et les éléments de ligne de bon de commande. La mise à jour du code de devise d’une commande existante n’est pas prise en charge. La fourniture d’une valeur autre que le code de devise déjà associé à la commande entraîne le rejet de la mise à jour. Type de données : chaîne |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| produitÉlémentCommande.action | Requis si le productOrderItem paramètre est utilisé. Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles :
Type de données : chaîne Stocké dans : champ d’action de la table sn_ind_tmt_orm_order_line_item. Par défaut : ajouter |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Si l’action de l’élément est suspendre ou reprendre, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : champ committed_due_date de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.externalProductInventory.externalProductInventoryId | ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : le champ external_inventory_id de la table sn_ind_tmt_orm_order_line_item et le champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory. |
| produitÉlémentCommande.InventaireProduitexterne | Liste des ID externes à mapper aux inventaires des produits créés pour la commande. Type de données : tableau d’objets Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée. |
| productOrderItem.id | Requis si le productOrderItem paramètre est utilisé. Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order_line_item. Longueur maximale : 40 Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice | Liste décrivant le prix associé au produit. Type de données : tableau d’objets Stocké dans : 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 Stocké dans : sn_ind_tmt_orm_order_line_item Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice.price.taxIncludedAmount | Description du prix du produit associé, taxes comprises. Type de données : objet Stocké dans : 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 Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Prix du produit, taxe comprise. Type de données : nombre Stocké dans : champ mrc ou nrc de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent. Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois. Type de données : chaîne |
| produitÉlémentCommande.produit | Requis si productOrderItem.action est modifié ou supprimé. Description des détails d’instance du produit acheté par le client. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.id | Requis si productOrderItem.action est modifié ou supprimé. 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 |
| produitÉlémentCommande.produit.place | Cartes des emplacements d’installation du produit. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.place.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours Lieu. Ces informations ne sont pas stockées. Type de données : chaîne |
| 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]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement. Type de données : chaîne Stocké dans : champ d’emplacement de la table sn_ind_tmt_orm_order_line_item. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne Stocké dans : Le champ des caractéristiques de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : previous_characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : champ characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| productItemOrder.product.productCharacteristic.valueType | Type de valeur caractéristique. Type de données : chaîne Valeurs possibles :
|
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit. Remarque :
Les ordres de changement (productOrderItem.action est un changement) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. La valeur de cette propriété système détermine le mode de traitement de la commande si la version de l’inventaire des produits est différente de celle indiquée dans la commande.
Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.productSpecification.id | Requis si le productOrderItem.product.productSpecification paramètre est utilisé. Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version interne du cahier des charges. Doit correspondre à la valeur de version sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Situé dans la table Product Specification (Spécification de produit) [sn_prd_pm_product_specification]. Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Doit correspondre à la valeur de internalVersion sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.@referredType | Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact. Type de données : chaîne Stocké dans : champ d’e-mail de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact. Type de données : chaîne Stocké dans : champ first_name de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.product.relatedParty.id | Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne Stocké dans : champ sys_id de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact. Type de données : chaîne Stocké dans : champ lastName de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.Partieconnexe.téléphone | Numéro de téléphone professionnel du contact. Type de données : chaîne Stocké dans : champ business_phone de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | Requis si le productOrderItem.productOffering paramètre est utilisé. Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOrderItem.productOffering.internalVersion | Version de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOrderItem.productOffering.version | External_version de l’offre de produit. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOrderItem.quantity | Nombre d’éléments associés à commander. Type de données : nombre Stocké dans : champ Quantité du sn_ind_tmt_orm_order. Valeur par défaut : null |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | Requis si le productOrderItem.productOrderItemRelationship paramètre est utilisé. Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Stocké dans : champ parent_line_item de thebsn_ind_tmt_orm_order_line_item table. Valeur par défaut : chaîne vide |
| productOrderItem.productOrderItemRelationship.relationshipType | Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles :
HasChild et HasParent sont utilisés pour les relations parent/enfant. Exige est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne).Type de données : chaîne |
| productOrderItem.quantity | Nombre d’éléments commandés. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| productOrderItem.revisionOperation | Type de mise à jour à effectuer sur l’élément de ligne. Si cette valeur est vide, l’élément de ligne existant est mis à jour ou un nouvel élément de ligne est ajouté s’il n’existe pas déjà. Si cette valeur est Annuler, l’élément de ligne est annulé. Type de données : chaîne Valeur par défaut : chaîne vide |
| Fête connexe | |
| relatedParty.@referredType | |
| relatedParty.@type | |
| relatedParty.id | |
| relatedParty.name | |
| requestedCompletionDate | Date de livraison demandée par le client. Type de données : chaîne Stocké dans : champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| requestedStartDate | Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Réussi. En cas de problème avec les caractéristiques ou les informations d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé :
|
| 400 | Demande incorrecte. Peut être l’une des raisons suivantes :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Liste des canaux à utiliser pour vendre les produits.
Type de données : tableau d’objets |
| channel.id | Identificateur unique du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| channel.name | Nom du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| id | Sys_id de la commande de clients mise à jour pour cette demande. Type de données : chaîne |
| externalId | Identificateur externe de la commande client, tel qu’un numéro de bon de commande. Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande.
Type de données : tableau d’objets |
| note.texte | Notes/commentaires supplémentaires effectués par le client lors de la commande.
Type de données : chaîne |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets |
| produitÉlémentCommande.action | Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item.
Type de données : chaîne |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.id | Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
Type de données : chaîne |
| productOrderItem.itemPrice | Liste décrivant le prix associé au produit.
Type de données : tableau d’objets |
| productOrderItem.itemPrice.price | Description du prix du produit associé.
Type de données : objet |
| productOrderItem.itemPrice.price.taxIncludeAmount | Description du prix du produit associé, taxes comprises.
Type de données : objet |
| 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, taxe comprise.
Type de données : nombre |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent.
Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois.
Type de données : chaîne |
| produitÉlémentCommande.produit | Description des détails d’instance du produit acheté par le client.
Type de données : objet |
| productOrderItem.product.id | Identificateur unique du produit vendu. Situé dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory].
Type de données : chaîne |
| productOrderItem.product.place | Cartes des emplacements d’installation du produit.
Type de données : objet |
| productOrderItem.product.place.id | Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé.
Type de données : tableau d’objets |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic].
Type de données : chaîne |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit.
Type de données : objet |
| productOrderItem.product.productSpecification.id | Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications 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 Product Specification (Spécification de produit) [sn_prd_pm_product_specification].
Type de données : chaîne |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées.
Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version interne du cahier des charges. Doit correspondre à la valeur de version sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Doit correspondre à la valeur de internalVersion sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne.
Type de données : tableau d’objets |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.id | Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact].
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact.
Type de données : chaîne Type de données : chaîne |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.@referredType | Type de client.
Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit.
Type de données : objet |
| productOrderItem.productOffering.id | Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande.
Type de données : tableau d’objets |
| productOrderItem.productOrderItemRelationship.id | Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
Type de données : chaîne |
| productOrderItem.productOrderItemRelationship.relationshipType | Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations.
Type de données : chaîne |
| productOrderItem.quantity | Nombre 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 d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur.
Type de données : tableau d’objets |
| relatedParty.id | Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Ils se trouvent 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 :
Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client.
Type de données : chaîne |
| requestedStartDate | Date de début de commande demandée par le client.
Type de données : chaîne |
| État | État actuel de la commande. Type de données : chaîne |
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
Demande cURL
L’exemple de code suivant met à jour le canal d’une commande client.
curl -X PATCH "https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder/6be0a925c3a220103e2e73ce3640ddfe" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
]
}Corps de la réponse.
{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"externalSystem": "Salesforce – TMF 641",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization"
"valueType": "Choice",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef",
"externalVersion": "1",
"@version": "v1"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
"externalVersion": "1",
"@version": "v1"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder",
"id": "6be0a925c3a220103e2e73ce3640ddfe",
"state": "in_progress"
}API ouverte de commande de produit : POST /sn_ind_tmt_orm/cancelproductorder
Annule la commande client spécifiée.
Format d'URL
URL par défaut : /api/sn_ind_tmt_orm/cancelproductorder
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| motif d’annulation | Motif de l’annulation. Type de données : chaîne Valeur par défaut : chaîne vide |
| productOrder | Contient des données sur la commande de produit. Type de données : objet |
| productOrder.id | Requis. Sys_id de la commande du client à annuler. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order] |
| productOrder.href | URL de la commande de client à annuler. Type de données : chaîne Valeur par défaut : chaîne vide |
| productOrder.@referredType | La valeur de ce paramètre doit être ProductOrder.Type de données : chaîne Valeur par défaut : chaîne vide |
| requestedCancellationDate | Date d’annulation de la commande. Type de données : chaîne Valeur par défaut : chaîne vide |
| @type | La valeur de ce paramètre doit être CancelProductOrder.Type de données : chaîne Valeur par défaut : chaîne vide |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Peut être l’une des raisons suivantes :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| motif d’annulation | Motif de l’annulation. Type de données : chaîne |
| href | URL de la commande annulée. Type de données : chaîne |
| id | Sys_id de la commande annulée. Type de données : chaîne |
| productOrder | Données relatives à la commande de produit. Type de données : objet |
| productOrder.id | Sys_id de la commande annulée. Type de données : chaîne |
| productOrder.href | URL de la commande annulée. Type de données : chaîne |
| productOrder.@referredType | La valeur de ce paramètre est ProductOrder.Type de données : chaîne |
| productOrder.@referredType | La valeur de ce paramètre est ProductOrderRef.Type de données : chaîne |
| requestedCancellationDate | Date d’annulation de la commande. Type de données : chaîne |
| État | État de l’annulation. Si la demande d’annulation a été traitée avec succès (code de statut 201), la valeur de ce paramètre est effectuée.Type de données : chaîne |
| @type | La valeur de ce paramètre est CancelProductOrder.Type de données : chaîne |
Demande cURL
L’exemple de code suivant annule une commande client.
curl -X POST "https://instance.servicenow.com/api/sn_ind_tmt_orm/cancelproductorder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"cancellationReason": "Duplicate order",
"requestedCancellationDate": "2019-04-30T12:56:21.931Z",
"productOrder": {
"id": "163ee2805358811032a4ddeeff7b122d",
"href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
"@referredType": "ProductOrder"
},
"@type": "CancelProductorder"
}{
"id": "163ee2805358811032a4ddeeff7b122d",
"href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
"cancellationReason": "Duplicate order",
"requestedCancellationDate": "2019-04-30T12:56:21.931Z",
"@type": "CancelProductorder",
"productOrder": {
"id": "163ee2805358811032a4ddeeff7b122d",
"href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
"@referredType": "ProductOrder"
},
"state": "done"
}API ouverte de commande de produit : POST /sn_ind_tmt_orm/order/productOrder
Crée la commande client et les éléments de ligne de commande client spécifiés.
Une fois traités, les enregistrements sont créés dans les tables suivantes :
- Commande de clients [sn_ind_tmt_orm_order]
- Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
- Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
- Contact 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
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Mode | Permet un traitement asynchrone des commandes. En d’autres termes, la commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] pour être créée. Si elle n’est pas incluse, la commande est traitée de manière synchrone. Valeur valide : asynchrone Type de données : chaîne |
| Nom | Description |
|---|---|
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
| canal | Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets Stocké dans : 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 Stocké dans : champ Canal de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| channel.name | Nom du canal à utiliser pour vendre les produits associés. Les noms de canaux possibles sont définis dans l’onglet Liste de choix de l’entrée du dictionnaire des canaux de la table sn_ind_tmt_orm_order. Type de données : chaîne Valeur par défaut : chaîne vide |
| committedDueDate |
Date et heure auxquelles l’action doit être effectuée sur la commande.
Cette valeur doit être identique ou postérieure aux valeurs de chaque élément de ligne de committedDueDate bon de commande. Type de données : chaîne Stocké dans : champ committed_due_date de la table sn_ind_tmt_orm_order. |
| externalId | Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| Système externe | Système externe de la commande de produit, joint au TMF622. Par exemple, si le système externe est ABC, saisissez la valeur externalSystem Type de données : chaîne |
| href | Lien relatif à l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide |
| remarque | Remarques supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order |
| note.texte | Requis. Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| orderCurrency | Requis. Code de devise pour la commande et les éléments de ligne de bon de commande. La devise doit être la même pour tous les éléments de la commande et des éléments de ligne de commande, sinon une erreur est renvoyée et la commande n’est pas créée. Une fois qu’une commande est créée, son code de devise ne peut pas être modifié. Type de données : chaîne |
| productOrderItem | Requis. Éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| produitÉlémentCommande.action | Requis. Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles :
Type de données : chaîne Stocké dans : Le champ d’action de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.actionReason | Facultatif. Description du motif de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : champ action_reason de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.committedDueDate |
Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande.
Type de données : chaîne Stocké dans : champ committed_due_date de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.externalProductInventory.externalProductInventoryId | ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : le champ external_inventory_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] et le champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory. |
| produitÉlémentCommande.InventaireProduitexterne | ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets |
| productOrderItem.id | Requis. Identificateur unique de l’élément de ligne. Type de données : chaîne Stocké dans : champ external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Longueur maximale : 40 Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice | Prix associé au produit. Type de données : tableau d’objets Stocké dans : 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 Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice.price.taxIncludedAmount | Description du prix du produit associé, taxes comprises. Type de données : objet Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Code de devise dans lequel le prix est exprimé. Type de données : chaîne Stocké dans : champ mrc ou nrc de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Prix du produit, taxe comprise. Type de données : nombre Stocké dans : champ mrc ou nrc de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.priceType | Spécifie si le prix de l’élément est récurrent ou non récurrent. Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois. Type de données : chaîne |
| produitÉlémentCommande.produit | Requis si productOrderItem.action est modifié ou supprimé. Détails d’instance du produit acheté par le client. Type de données : objet Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.id | Requis si productOrderItem.action est modifié ou supprimé. Identificateur unique du produit vendu. Type de données : chaîne Valeur par défaut : chaîne vide Table : dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. |
| productOrderItem.product.place | Cartes des emplacements d’installation du produit. Type de données : objet Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.product.place.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours Lieu. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.place.id | Requis. Sys_id de l’enregistrement de l’emplacement associé. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement. Type de données : chaîne Table : Emplacement [cmn_location] Stocké dans : champ Emplacement de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Caractéristiques du produit associé. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Type de données : chaîne Table : caractéristique [sn_prd_pm_characteristic] Stocké dans : Le champ des caractéristiques de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : champ previous_characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : champ characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| productItemOrder.product.productCharacteristic.valueType | Type de valeur caractéristique. Valeurs possibles :
Type de données : chaîne |
| produitCommandeÉlément.produit.produitSpécification | Facultatif. Description de la spécification du produit associée au produit. Remarque :
Les ordres de changement (productOrderItem.action est un changement) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. La valeur de cette propriété système détermine le mode de traitement de la commande si la version de l’inventaire des produits est différente de celle indiquée dans la commande.
Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.productSpecification.id | Requis. Version initiale ou ID externe de la spécification du produit. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version interne de la spécification de service. Doit correspondre à la valeur de version sinon une erreur est générée. Type de données : chaîne |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification de service. Doit correspondre à la valeur de internalVersion sinon une erreur est générée. Type de données : chaîne |
| produitÉlémentCommande.produit.Partieconnexe | Liste des rôles de partie liés à un OrderLineItemContact. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.@referredType | Requis. Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact. Type de données : chaîne Stocké dans : champ d’e-mail de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact. Type de données : chaîne Stocké dans : champ first_name de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact. Type de données : chaîne Stocké dans : champ lastName de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact. Type de données : chaîne Stocké dans : champ business_phone de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.productOffering | Requis. Description de l’offre de produit associée au produit. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | Requis. Version initiale ou ID externe de l’offre de produit. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.internalVersion | Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering]. |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.version | Version externe de l’offre de produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering]. |
| productOrderItem.productOrderItem.quantity | Nombre d’éléments associés à commander. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : null |
| productOrderItem.productOrderItemRelationship | Requis. Liste qui décrit la relation parent/enfant entre les éléments de commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | Requis. Identique à la productOrderItem.id valeur. Utilisé pour la relation parent/enfant Type de données : chaîne Stocké dans : champ parent_line_item de la table sn_ind_tmt_orm_order_line_item. Valeur par défaut : chaîne vide |
| productOrderItem.productOrderItemRelationship.relationshipType | Requis. Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles :
Type de données : chaîne |
| productOrderItem.quantity | Nombre d’éléments commandés. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur. Type de données : tableau d’objets |
| relatedParty.@referredType | Requis. Type de client. Valeurs possibles :
Type de données : chaîne |
| relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées. Type de données : chaîne |
| relatedParty.id | Sys_id ou external_id du compte ou du contact client associé à la commande. Type de données : chaîne Table : table Compte [customer_account], table Contact [customer_contact] ou Consommateur [csm_consumer] |
| relatedParty.name | Nom du compte, du client ou du consommateur. Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client. Type de données : chaîne Stocké dans : champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| requestedStartDate | Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Réussi. En cas de problème avec les caractéristiques ou les informations d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé :
|
| 202 | Accepté. Demande de commande réussie en mode asynchrone. En d’autres termes, la demande a été effectuée avec le mode paramètre défini sur async et l’enregistrement est planifié pour être traité dans la table File d’attente entrante [sn_tmt_core_inbound_queue]. |
| 400 | Demande incorrecte. Peut être l’une des raisons suivantes :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| canal | Liste des canaux à utiliser pour vendre les produits.
Type de données : tableau d’objets |
| channel.id | Identificateur unique du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| channel.name | Nom du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| committedDueDate | Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque élément de ligne de committedDueDate bon de commande. Type de données : chaîne |
| externalId | 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 de client créée pour cette demande. Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande.
Type de données : tableau d’objets |
| note.texte | Notes/commentaires supplémentaires effectués par le client lors de la commande.
Type de données : chaîne |
| orderCurrency | Code de devise pour la commande et les éléments de ligne de bon de commande. Type de données : chaîne |
| orderId | Sys_id de la commande à créer. En cas de succès, la commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] sur un calendrier pour être traitée. Remarque :
Cette valeur est le seul résultat si la commande est créée de façon asynchrone à l’aide du paramètre query mode . Type de données : chaîne |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets |
| produitÉlémentCommande.action | Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item.
Type de données : chaîne |
| productOrderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne |
| produitÉlémentCommande.InventaireProduitexterne | Liste des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau d’objets |
| 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 | Liste décrivant le prix associé au produit.
Type de données : tableau d’objets |
| productOrderItem.itemPrice.price | Description du prix du produit associé.
Type de données : objet |
| productOrderItem.itemPrice.price.taxIncludeAmount | Description du prix du produit associé, taxes comprises.
Type de données : objet |
| 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, taxe comprise.
Type de données : nombre |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent.
Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois.
Type de données : chaîne |
| produitÉlémentCommande.produit | Description des détails d’instance du produit acheté par le client.
Type de données : objet |
| 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 la productOrderItem.action valeur est modifier ou supprimer. 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 d’installation du produit.
Type de données : objet |
| productOrderItem.product.place.id | Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé.
Type de données : tableau d’objets |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic].
Type de données : chaîne |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| productOrderItem.product.productRelationship | Liste des détails des relations de produits pour un élément de ligne de commande. Type de données : tableau |
| productOrderItem.product.productRelationship.id | Sys_id ou sn_prd_invt_external_id de l’inventaire des produits. Type de données : chaîne Table : champ Sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. |
| 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 |
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit. Type de données : objet |
| productOrderItem.product.productSpecification.id | Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications 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 | Version initiale du cahier des charges. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Situé dans la table Product Specification (Spécification de produit) [sn_prd_pm_product_specification].
Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées.
Type de données : chaîne |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact.
Type de données : chaîne Type de données : chaîne |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact.
Type de données : chaîne |
| productOrderItem.product.relatedParty.@referredType | Type de client.
Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit. Type de données : objet |
| productOrderItem.productOffering.id | Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de 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 | Version initiale de l’offre de produits. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.internalVersion | Version de l’offre de produits. Type de données : chaîne Table : table Offre de produits [sn_prd_pm_product_offering], version du champ. |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOffering.version | Version externe de l’offre de produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering]. |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande.
Type de données : tableau d’objets |
| 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 et HasParent sont utilisés pour les relations parent/enfant. Exige est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne).Type de données : chaîne |
| productOrderItem.quantity | Nombre d’éléments associés à commander.
Type de données : nombre |
| productOrderItem.state | État actuel de l’élément de commande de produit. Cette valeur est toujours nouvelle. Type de données : chaîne |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur.
Type de données : tableau d’objets |
| relatedParty.id | Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Ils se trouvent 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 :
Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client.
Type de données : chaîne |
| requestedStartDate | Date de début de commande demandée par le client.
Type de données : chaîne |
| État | État actuel de la commande. Pour ce point de terminaison, cette valeur est toujours nouvelle. Type de données : chaîne |
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
Traitement asynchrone
Cet exemple montre comment utiliser le mode paramètre de requête pour créer une commande de manière asynchrone. La commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] sur un calendrier à créer.
curl -X POST 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder?mode=async' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"orderDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-4ddd56",
"orderCurrency": "USD",
"note": [
{
"id": "1",
"author": "Jean Pontus",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration"
},
{
"id": "2",
"author": "Jean Pontus1",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "100",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"product": {
"isBundle": false,
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "110",
"relationshipType": "HasChild"
},
{
"id": "120",
"relationshipType": "HasChild"
},
{
"id": "130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem"
},
{
"id": "110",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"description": "Access Fee",
"name": "Access Fee",
"priceType": "nonRecurring",
"price": {
"taxRate": 0,
"dutyFreeAmount": {
"unit": "USD",
"value": 100
},
"taxIncludedAmount": {
"unit": "USD",
"value": 220
}
}
}
],
"product": {
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "string",
"value": "Premium (>50 sites)"
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"@type": "ProductSpecificationRef"
},
"place": {
"@type": "Place",
"id": "5671dd2ec3a53010188473ce3640dd81"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
},
{
"id": "120",
"action": "add",
"actionReason":"adding service package OLI",
"quantity": 1,
"itemPrice": [
{
"description": "Tariff plan monthly fee",
"name": "MonthlyFee",
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxRate": 0,
"dutyFreeAmount": {
"unit": "USD",
"value": 300
},
"taxIncludedAmount": {
"unit": "USD",
"value": 349
}
}
}
],
"product": {
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Model",
"valueType": "string",
"value": "ASR"
},
{
"name": "WAN Optimization",
"valueType": "string",
"value": "Advance"
},
{
"name": "CPE Type",
"valueType": "string",
"value": "Physical"
},
{
"name": "Routing",
"valueType": "string",
"value": "Premium"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"place": {
"@type": "Place",
"id": "5671dd2ec3a53010188473ce3640dd81"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
},
{
"id": "130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"description": "Tariff plan monthly security",
"name": "MonthlySecurity",
"priceType": "nonRecurring",
"price": {
"taxRate": 0,
"dutyFreeAmount": {
"unit": "USD",
"value": 30
},
"taxIncludedAmount": {
"unit": "USD",
"value": 30
}
}
}
],
"product": {
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "string",
"value": "Premium"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"place": {
"@type": "Place",
"id": "5671dd2ec3a53010188473ce3640dd81"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder"
}'Corps de la réponse.
{
"orderId": "304e877ac3ab5110856d73ce3640dde5"
}Traitement de façon synchrone (par défaut)
L’exemple suivant montre comment créer une commande de produit.
curl -X POST "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"currencyCode": "USD",
"channel": [
{
"id": "2",
"name": "Online channel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
],
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI130",
"relationshipType": "Requires"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder"
}Corps de la réponse.
{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"currencyCode": "USD",
"channel": [
{
"id": "2",
"name": "Online chanel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"internalVersion": "1",
"version": "v1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"internalVersion": "1",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"internalVersion": "1",
"version": "v1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
],
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"internalVersion": "1",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI130",
"relationshipType": "Requires"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"internalVersion": "1",
"version": "v1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"internalVersion": "1",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder",
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"state": "new"
}API ouverte de commande de produit : POST /sn_ind_tmt_orm/productorder
Crée la commande client et les éléments de ligne de commande client spécifiés.
Important :
Ce point de terminaison est obsolète depuis la Tokyo mise en production. La nouvelle version de ce point de terminaison est API ouverte de commande de produit : POST /sn_ind_tmt_orm/order/productOrder.
Une fois traités, de nouveaux enregistrements sont créés dans les tables suivantes :
- Commande de clients [sn_ind_tmt_orm_order]
- Caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
- Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
- Contact 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
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
| canal | Liste des canaux à utiliser pour vendre les produits. Type de données : tableau d’objets Stocké dans : 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 Stocké dans : champ Canal de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| channel.name | Nom du canal à utiliser pour vendre les produits associés. Les noms de canaux possibles sont définis dans l’onglet Liste de choix de l’entrée du dictionnaire des canaux de la table sn_ind_tmt_orm_order. Type de données : chaîne Valeur par défaut : chaîne vide |
| committedDueDate |
Date et heure auxquelles l’action doit être effectuée sur la commande.
Cette valeur doit être identique ou postérieure aux valeurs de chaque élément de ligne de committedDueDate bon de commande. Type de données : chaîne Stocké dans : champ committed_due_date de la table sn_ind_tmt_orm_order. |
| externalId | Identificateur unique de la commande client. Cette valeur est déterminée par un système externe. Type de données : chaîne Stocké dans : champ external_id de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| Système externe | Système externe de la commande de produit, joint au TMF622. Par exemple, si le système externe est ABC, saisissez la valeur externalSystem Type de données : chaîne |
| href | Lien relatif à l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide |
| remarque | Remarques supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order |
| note.texte | Requis. Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| orderCurrency | Requis. Code de devise pour la commande et les éléments de ligne de bon de commande. La devise doit être la même pour tous les éléments de la commande et des éléments de ligne de commande, sinon une erreur est renvoyée et la commande n’est pas créée. Une fois qu’une commande est créée, son code de devise ne peut pas être modifié. Type de données : chaîne |
| productOrderItem | Requis. Éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| produitÉlémentCommande.action | Requis. Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles :
Type de données : chaîne Stocké dans : Le champ d’action de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.actionReason | Facultatif. Description du motif de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : champ action_reason de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.committedDueDate |
Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande.
Type de données : chaîne Stocké dans : champ committed_due_date de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.externalProductInventory.externalProductInventoryId | ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : le champ external_inventory_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] et le champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory. |
| produitÉlémentCommande.InventaireProduitexterne | ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets |
| productOrderItem.id | Requis. Identificateur unique de l’élément de ligne. Type de données : chaîne Stocké dans : champ external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Longueur maximale : 40 Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice | Prix associé au produit. Type de données : tableau d’objets Stocké dans : 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 Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] Valeur par défaut : chaîne vide |
| productOrderItem.itemPrice.price.taxIncludedAmount | Description du prix du produit associé, taxes comprises. Type de données : objet Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Code de devise dans lequel le prix est exprimé. Type de données : chaîne Stocké dans : champ mrc ou nrc de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Prix du produit, taxe comprise. Type de données : nombre Stocké dans : champ mrc ou nrc de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.priceType | Spécifie si le prix de l’élément est récurrent ou non récurrent. Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois. Type de données : chaîne |
| produitÉlémentCommande.produit | Requis si productOrderItem.action est modifié ou supprimé. Détails d’instance du produit acheté par le client. Type de données : objet Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.id | Requis si productOrderItem.action est modifié ou supprimé. Identificateur unique du produit vendu. Type de données : chaîne Valeur par défaut : chaîne vide Table : dans le champ sys_id ou sn_ind_tmt_orm_external_id de la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. |
| productOrderItem.product.place | Cartes des emplacements d’installation du produit. Type de données : objet Stocké dans : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.product.place.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours Lieu. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.place.id | Requis. Sys_id de l’enregistrement de l’emplacement associé. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement. Type de données : chaîne Table : Emplacement [cmn_location] Stocké dans : champ Emplacement de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Caractéristiques du produit associé. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Type de données : chaîne Table : caractéristique [sn_prd_pm_characteristic] Stocké dans : Le champ des caractéristiques de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : champ previous_characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne Stocké dans : champ characteristic_option_value de la table sn_ind_tmt_orm_order_characteristic_value. Valeur par défaut : chaîne vide |
| productItemOrder.product.productCharacteristic.valueType | Type de valeur caractéristique. Valeurs possibles :
Type de données : chaîne |
| produitCommandeÉlément.produit.produitSpécification | Facultatif. Description de la spécification du produit associée au produit. Remarque :
Les ordres de changement (productOrderItem.action est un changement) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. La valeur de cette propriété système détermine le mode de traitement de la commande si la version de l’inventaire des produits est différente de celle indiquée dans la commande.
Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.productSpecification.id | Requis. Version initiale ou ID externe de la spécification du produit. La version initiale est le sys_id de la première version de la spécification. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version interne de la spécification de service. Doit correspondre à la valeur de version sinon une erreur est générée. Type de données : chaîne |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification]. |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification de service. Doit correspondre à la valeur de internalVersion sinon une erreur est générée. Type de données : chaîne |
| produitÉlémentCommande.produit.Partieconnexe | Liste des rôles de partie liés à un OrderLineItemContact. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.@referredType | Requis. Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées. Type de données : chaîne |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact. Type de données : chaîne Stocké dans : champ d’e-mail de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact. Type de données : chaîne Stocké dans : champ first_name de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact. Type de données : chaîne Stocké dans : champ lastName de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact. Type de données : chaîne Stocké dans : champ business_phone de la table sn_ind_tmt_orm_order_line_item_contact. Valeur par défaut : chaîne vide |
| productOrderItem.productOffering | Requis. Description de l’offre de produit associée au produit. Type de données : objet Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | Requis. Version initiale ou ID externe de l’offre de produit. La version initiale est le sys_id de la première version de l’offre. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.internalVersion | Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering]. |
| productOrderItem.productOffering.name | Nom de l’offre de produits. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering] |
| productOrderItem.productOffering.version | Version externe de l’offre de produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering]. |
| productOrderItem.productOrderItem.quantity | Nombre d’éléments associés à commander. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : null |
| productOrderItem.productOrderItemRelationship | Requis. Liste qui décrit la relation parent/enfant entre les éléments de commande. Type de données : tableau d’objets Stocké dans : sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | Requis. Identique à la productOrderItem.id valeur. Utilisé pour la relation parent/enfant Type de données : chaîne Stocké dans : champ parent_line_item de la table sn_ind_tmt_orm_order_line_item. Valeur par défaut : chaîne vide |
| productOrderItem.productOrderItemRelationship.relationshipType | Requis. Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles :
Type de données : chaîne |
| productOrderItem.quantity | Nombre d’éléments commandés. Type de données : nombre Stocké dans : champ Quantité de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur. Type de données : tableau d’objets |
| relatedParty.@referredType | Requis. Type de client. Valeurs possibles :
Type de données : chaîne |
| relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées. Type de données : chaîne |
| relatedParty.id | Sys_id ou external_id du compte ou du contact client associé à la commande. Type de données : chaîne Table : table Compte [customer_account], table Contact [customer_contact] ou Consommateur [csm_consumer] |
| relatedParty.name | Nom du compte, du client ou du consommateur. Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client. Type de données : chaîne Stocké dans : champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
| requestedStartDate | Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Réussi. En cas de problème avec les caractéristiques ou les informations d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé :
|
| 400 | Demande incorrecte. Peut être l’une des raisons suivantes :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| @type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrder. Ces informations ne sont pas stockées. Type de données : chaîne |
| canal | Liste des canaux à utiliser pour vendre les produits.
Type de données : tableau d’objets |
| channel.id | Identificateur unique du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| channel.name | Nom du canal à utiliser pour vendre les produits associés.
Type de données : chaîne |
| externalId | Identificateur externe de la commande client, tel qu’un numéro de bon de commande. Type de données : chaîne |
| Système externe | Système externe de la commande de produit, joint au TMF622. Par exemple, si le système externe est ABC, saisissez la valeur externalSystem Type de données : chaîne |
| id | Sys_id de la commande de client créée pour cette demande. Type de données : chaîne |
| remarque | Liste des notes supplémentaires prises par le client lors de la commande.
Type de données : tableau d’objets |
| note.texte | Notes/commentaires supplémentaires effectués par le client lors de la commande.
Type de données : chaîne |
| productOderItem.actionReason | Motif d’ajout de l’élément de ligne de commande. Type de données : chaîne Stocké dans : champ action_reason de la table sn_ind_tmt_orm_order_line_item. |
| productOrderItem | Liste décrivant les éléments associés à la commande de produit et leur action associée. Type de données : tableau d’objets |
| productOrderItem.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours ProductOrderItem. Ces informations ne sont pas stockées. Type de données : chaîne |
| produitÉlémentCommande.action | Action à réaliser sur le produit. Les actions possibles sont définies dans l’onglet Liste de choix de l’entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item.
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 | Liste décrivant le prix associé au produit.
Type de données : tableau d’objets |
| productOrderItem.itemPrice.price | Description du prix du produit associé.
Type de données : objet |
| productOrderItem.itemPrice.price.taxIncludeAmount | Description du prix du produit associé, taxes comprises.
Type de données : objet |
| 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, taxe comprise.
Type de données : nombre |
| productOrderItem.itemPrice.priceType | Type de prix d’élément, récurrent ou non récurrent.
Type de données : chaîne |
| produitCommandeÉlément.Prix.RecurringChargePeriod | Si le prix est récurrent, la période récurrente, par exemple le mois.
Type de données : chaîne |
| produitÉlémentCommande.produit | Description des détails d’instance du produit acheté par le client.
Type de données : objet |
| productOrderItem.product.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le produit. Cette valeur est toujours Produit. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.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 la productOrderItem.action valeur est modifier ou supprimer. 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 d’installation du produit.
Type de données : objet |
| productOrderItem.product.place.id | Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Lors de l’utilisation de l’action de changement sur un élément de commande de produit (via le productOrderItem.action paramètre), la mise à jour de la demande avec un nouvel emplacement sys_id crée un ordre de déplacement, dans lequel l’ordre n’est pas modifié, mais est exécuté dans un nouvel emplacement.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique du produit | Liste des caractéristiques du produit associé.
Type de données : tableau d’objets |
| productOrderItem.product.productCharacteristic.name | Nom de l’enregistrement de caractéristique à associer au produit. Situé dans la table Caractéristique [sn_prd_pm_characteristic].
Type de données : chaîne |
| élémentcommandeproduit.produit.caractéristique.valeurprécédente | Valeurs des options de caractéristiques précédentes si la mise à jour concerne un ordre de changement. La demande est un ordre de changement si le paramètre est différent de AjouterproductOrderItem.action. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| produitÉlémentCommande.produit.produitCaractéristique.valeur | Valeurs d’option de caractéristique associées au produit. Pour plus d’informations sur les valeurs d’option caractéristiques, reportez-vous à la section Create product characteristics and characteristic options.
Type de données : chaîne |
| productItemOrder.product.productCharacteristic.valueType | Type de valeur caractéristique. Valeurs possibles :
Type de données : chaîne |
| produitCommandeÉlément.produit.produitSpécification | Description de la spécification du produit associée au produit.
Type de données : objet |
| productOrderItem.product.productSpecification.@type | Fait partie de la norme d’API ouverte TMF. Cette valeur est toujours ProductSpecificationRef. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.product.productSpecification.id | Initial_version ou external_id de la spécification du produit. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications 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 |
| élémentcommandeproduit.produit.spécificationproduit.internalVersion | Version interne du cahier des charges. Doit correspondre à la valeur de version sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| productOrderItem.product.productSpecification.name | Nom de la spécification de produit. Situé dans la table Product Specification (Spécification de produit) [sn_prd_pm_product_specification].
Type de données : chaîne |
| élémentcommandeproduit.produit.spécificationproduit.version | Version externe de la spécification du produit. Doit correspondre à la valeur de internalVersion sinon une erreur est générée. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification] |
| produitÉlémentCommande.produit.Partieconnexe | Liste de contacts pour les éléments de ligne. Type de données : tableau d’objets |
| productOrderItem.product.relatedParty.@referredType | Type de client.
Valeur possible : OrderLineItemContact Type de données : chaîne |
| productOrderItem.product.relatedParty.@type | Fait partie de la norme d’API ouverte TMF. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées.
Type de données : chaîne |
| productOrderItem.product.relatedParty.email | Adresse e-mail du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.prénom | Prénom du contact.
Type de données : chaîne |
| élémentcommandeproduit.produit.partieconnexe.nom de famille | Nom de famille du contact.
Type de données : chaîne Type de données : chaîne |
| productOrderItem.product.relatedParty.phone | Numéro de téléphone professionnel du contact.
Type de données : chaîne |
| productOrderItem.productOffering | Description de l’offre de produit associée au produit.
Type de données : objet |
| productOrderItem.productOffering.id | Initial_version ou external_id de l’offre de produits. Le initial_version est le sys_id de la première version de l’offre. Situé dans le champ sys_id ou external_id de la table Offre de 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 produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].
Type de données : chaîne |
| productOrderItem.productOrderItemRelationship | Liste des relations entre les éléments de ligne de commande.
Type de données : tableau d’objets |
| productOrderItem.productOrderItemRelationship.id | Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
Type de données : chaîne |
| productOrderItem.productOrderItemRelationship.relationshipType | Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations.
Type de données : chaîne |
| productOrderItem.quantity | Nombre 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 |
| Fête connexe | Liste des contacts de la commande. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations sur un compte client ou un compte consommateur.
Type de données : tableau d’objets |
| relatedParty.id | Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Ils se trouvent 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 :
Type de données : chaîne |
| requestedCompletionDate | Date de livraison demandée par le client.
Type de données : chaîne |
| requestedStartDate | Date de début de commande demandée par le client.
Type de données : chaîne |
| serviceItemOrder.service.serviceSpecification.internalVersion | Version interne de la spécification de service. Doit correspondre à la valeur de version sinon une erreur est générée. Type de données : chaîne |
| serviceItemOrder.service.serviceSpecification.version | Version externe de la spécification de service. Doit correspondre à la valeur de internalVersion sinon une erreur est générée. 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 |
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",
"externalSystem": "Salesforce – TMF 622",
"channel": [
{
"id": "2",
"name": "Online channel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"valueType": "Object",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef",
"externalVersion": "1",
"@version": "v1"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Object",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder"
}Corps de la réponse.
{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"externalSystem": "Salesforce – TMF 622",
"channel": [
{
"id": "2",
"name": "Online chanel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"valueType": "Object",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef",
"externalVersion": "1",
"@version": "v1"
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Object",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder",
"id": "6be0a925c3a220103e2e73ce3640ddfe",
"state": "new"
}