Catalogue de produits API ouverte

Catalogue de produits Ouvrir l’API : GET /sn_prd_pm_adv/catalogmanagement/catalog

Récupère une liste de tous les catalogues d’offres de produits.

Format d'URL

URL par défaut : /api/sn_prd_pm_adv/catalogmanagement/catalog

Paramètres de demande pris en charge

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

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

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

En-têtes

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

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

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

Codes d'état

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

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

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


Nom	Description
description	Description du catalogue d’offres de produits. Type de données : chaîne
ID	Sys_id du catalogue d’offres de produits depuis la table Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]. Type de données : chaîne
nom	Nom du catalogue d’offres de produits. Type de données : chaîne

Demande cURL

Cet exemple récupère tous les catalogues d’offres de produits.

curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/catalog" \
--user 'username':'password'

Corps de la réponse.

[
    {
        "id": "SD-WAN1344314wrfw14345",
        "name": "New Catalog",
        "description": "New Catalog"
    },
    {
        "id": "9919291ac34c20105252716b7d40dd0f",
        "name": "Enterprise Mobile Plan",
        "description": " Product Catalog for Enterprise Mobile Plan"
    }
]

Catalogue de produits Ouvrir l’API : GET /sn_prd_pm_adv/catalogmanagement/catalog/{catalogId}

Récupère un catalogue d’offres de produits.

Format d'URL

URL par défaut : /api/sn_prd_pm_adv/catalogmanagement/catalog/{catalogId}

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès
Nom	Description
ID catalogue	Sys_id du catalogue d’offres de produits à récupérer. Situé dans la table Catalogue des offres de produits [sn_prd_pm_product_offering_catalog]. Type de données : chaîne

Tableau 8. Paramètres de requête
Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n’est pas utilisé, tous les champs sont renvoyés. Type de données : chaîne

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

En-têtes

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

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

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

Codes d'état

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

Tableau 12. Codes d'état
Code d'état	Description
200	Demande traitée avec succès.
400	Demande incorrecte. Cela peut être l’une des raisons suivantes : Paramètre de chemin d’accès non valide URI non valide
404	Enregistrement introuvable. L’enregistrement associé à l’ID ne se trouve pas dans la table.

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


Nom	Description
description	Description du catalogue d’offres de produits. Type de données : chaîne
ID	Sys_id du catalogue d’offres de produits depuis la table Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]. Type de données : chaîne
nom	Nom du catalogue d’offres de produits. Type de données : chaîne

Demande cURL

Cet exemple récupère un catalogue d’offres de produits pour un forfait Mobile d’entreprise.

curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/catalog/9919291ac34c20105252716b7d40dd0f" \
--user 'username':'password'

Corps de la réponse.

{
   "id": "9919291ac34c20105252716b7d40dd0f",
   "name": "Enterprise Mobile Plan",
   "description": " Product Catalog for Enterprise Mobile Plan"
}

API ouverte Product Catalog : GET /sn_prd_pm_adv/catalogmanagement/productoffering

Récupère toutes les offres de produits.

Format d'URL

URL par défaut : /api/sn_prd_pm_adv/catalogmanagement/productoffering

Paramètres de demande pris en charge

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

Tableau 14. Paramètres de requête
Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : catégorie canal description ID externe ID internalId Version interne lastUpdate (en anglais seulement) nom Caractéristique du produit productOfferingPrice Terme de l’offre du produit Spécification du produit prodSpecCharValueUse valideFor version Par défaut : tous les champs sont renvoyés. Type de données : chaîne
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le offset paramètre pour paginer la récupération des enregistrements. Par défaut : 20 Maximum : 100 Type de données : nombre
décalage	Index de départ auquel commencer la récupération d’enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par défaut : 0 Type de données : nombre
Spécification	Filtrez les offres de produits par sys_id de spécifications de produit. Seules les offres de produits avec le sys_id de spécification de produit spécifié sont renvoyées dans la réponse. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
État	Filtrer les offres de produits par état. Seules les offres de produits dans l’état spécifié sont renvoyées dans la réponse. Type de données : chaîne

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

En-têtes

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

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

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

Codes d'état

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

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

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


Nom	Description
catégorie	Liste des catégories auxquelles appartient le produit. Type de données : tableau d’objets `"category:" [ { "id": "String", "name": "String" } ]`
category.id	ID de la catégorie. Type de données : chaîne
category.name	Nom de la catégorie. Type de données : chaîne
canal	Canaux à utiliser pour vendre l’offre de produit. Type de données : tableau d’objets `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
description.canal	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal à partir de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne
channel.name	Nom du canal. Type de données : chaîne
description	Description de l'offre de produit. Type de données : chaîne
ID externe	External_id de l’offre de produit issue de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
ID	Initial_version ou external_id de l’offre de produit à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
internalId	Initial_version de l’offre de produit à partir de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
Version interne	Version de l’offre de produit issue de la table Offres de produits [sn_prd_pm_product_offering]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de l’offre de produit. Type de données : chaîne
nom	Nom de l’offre de produit. Type de données : chaîne
Caractéristique du produit	Liste des caractéristiques du produit. Type de données : tableau d’objets `"productCharacteristic": [ { "name": "String", "value": "String" } ]`
productCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
valeur.CaractéristiqueProduit	Valeur de la caractéristique. Type de données : chaîne
productOfferingPrice	Informations sur le prix de l’offre de produit. Type de données : tableau d’objets `"productOfferingPrice": [ { "price": Object, "priceType": "String" } ]`
productOfferingPrice.price	Informations sur le prix de l’offre de produit. Type de données : objet `"price": { "taxIncludedAmount": Object }`
productOfferingPrice.price.taxIncludedAmount	Informations sur le prix de l’offre de produit. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": "String" }`
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise pour le prix de l’offre de produit. Type de données : chaîne
productOfferingPrice.price.taxIncludedAmount.value	Prix de l’offre de produits TTC. Type de données : chaîne
productOfferingPrice.priceType	Type de prix de l’offre de produit, paiement unique ou récurrent. Valeurs valides : non récurrent (ponctuel) Récurrents Type de données : chaîne
Terme de l’offre du produit	Durée du contrat valide pour l’offre de produit. Type de données : chaîne
Spécification du produit	Spécifications du produit. Type de données : objet `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Initial_version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productSpecification.internalId	Initial_version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.version	External_version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
prodSpecCharValueUse	Caractéristiques des offres de produits. Type de données : tableau d’objets `"prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristicValue	Valeurs possibles de la caractéristique. Type de données : tableau d’objets `"productSpecCharacteristicValue": [ { "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.description	Description de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.name	Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
prodSpecCharValueUse.validFor.endDateTime	Date de fin de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail.
valideFor	Plage de dates pour laquelle l’offre de produit est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de l’offre de produit. Type de données : chaîne
validFor.startDateTime	Date de début de l’offre de produit. Type de données : chaîne
version	External_version de l’offre de produit depuis la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Demande cURL

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

curl --location --request GET "https://instance.service-now.com/api/sn_prd_pm_adv/catalogmanagement/productoffering" \
--user 'username':'password'

Corps de réponse :

[
   {
      "id": "24413",
      "name": "Premium SD-WAN Offering New",
      "version": "",
      "internalVersion": "1",
      "internalId": "0199f8e65b430110235d85cced81c7d2",
      "description": "Premium SD-WAN Offering",
      "lastUpdate": "2022-01-27 05:41:16",
      "validFor": {
         "startDateTime": "2021-08-05",
         "endDateTime": "2026-09-04"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
         {
            "priceType": "recurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "JPY",
                  "value": 984.0913
               }
            }
         },
         {
            "priceType": "nonRecurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "GBP",
                  "value": 2434
               }
            }
         }
      ],
      "productSpecification": {
         "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
         "name": "SD-WAN Service Package",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
         {
            "name": "Routing",
            "description": "Routing",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:08:20"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "WAN Optimization",
            "description": "WAN Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:10:28"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "CPE Model",
            "description": "CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:54"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "ISR",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "ASR",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Security Type",
            "description": "Security Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-30 12:51:13"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247"
            }
         },
         {
            "name": "CPE Type",
            "description": "CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:16"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Tenancy",
            "description": "Tenancy",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:04:24"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Advance (50 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base (10 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium (>50 sites)",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5"
            }
         }
      ],
      "channel": [
         {
            "id": "e561aae4c3e710105252716b7d40dd8f",
            "name": "Web"
         }
      ],
      "category": {
         "id": "c0ed043653b02010cd6dddeeff7b1277",
         "name": "SD-WAN"
      }
   }
]

API ouverte du catalogue de produits : GET /sn_prd_pm_adv/catalogmanagement/productoffering/{offeringId}

Récupère une offre de produit.

Format d'URL

URL par défaut : /api/sn_prd_pm_adv/catalogmanagement/productoffering/{offeringId}

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès
Nom	Description
ID d’offre	Initial_version de l’offre de produit à récupérer. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Tableau 20. Paramètres de requête
Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : catégorie canal description ID externe ID internalId Version interne lastUpdate (en anglais seulement) nom Caractéristique du produit productOfferingPrice Terme de l’offre du produit Spécification du produit prodSpecCharValueUse valideFor version Par défaut : tous les champs sont renvoyés. Type de données : chaîne
Spécification	Filtrez les offres de produits par sys_id de spécifications de produit. Seules les offres de produits avec le sys_id de spécification de produit spécifié sont renvoyées dans la réponse. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
État	Filtrer les offres de produits par état. Seules les offres de produits dans l’état spécifié sont renvoyées dans la réponse. Type de données : chaîne

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

En-têtes

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

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

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

Codes d'état

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

Tableau 24. Codes d'état
Code d'état	Description
200	Demande traitée avec succès.
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Enregistrement introuvable. L’enregistrement associé à l’ID ne se trouve pas dans la table.

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


Nom	Description
catégorie	Liste des catégories auxquelles appartient le produit. Type de données : tableau `"category:" [ { "id": "String", "name": "String" } ]`
category.id	ID de la catégorie. Type de données : chaîne
category.name	Nom de la catégorie. Type de données : chaîne
canal	Canaux à utiliser pour vendre l’offre de produit. Type de données : tableau `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
description.canal	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal à partir de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne
channel.name	Nom du canal. Type de données : chaîne
description	Description de l'offre de produit. Type de données : chaîne
ID externe	External_id de l’offre de produit issue de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
ID	Initial_version ou external_id de l’offre de produit à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
internalId	Initial_version de l’offre de produit à partir de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
Version interne	Version de l’offre de produit issue de la table Offres de produits [sn_prd_pm_product_offering]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de l’offre de produit. Type de données : chaîne
nom	Nom de l’offre de produit. Type de données : chaîne
Caractéristique du produit	Liste des caractéristiques du produit. Type de données : tableau `"productCharacteristic": [ { "name": "String", "value": "String" } ]`
productCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
valeur.CaractéristiqueProduit	Valeur de la caractéristique. Type de données : chaîne
productOfferingPrice	Informations sur le prix de l’offre de produit. Type de données : tableau `"productOfferingPrice": [ { "price": Object, "priceType": "String" } ]`
productOfferingPrice.price	Informations sur le prix de l’offre de produit. Type de données : objet `"price": { "taxIncludedAmount": Object }`
productOfferingPrice.price.taxIncludedAmount	Informations sur le prix de l’offre de produit. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": "String" }`
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise pour le prix de l’offre de produit. Type de données : chaîne
productOfferingPrice.price.taxIncludedAmount.value	Prix de l’offre de produits TTC. Type de données : chaîne
productOfferingPrice.priceType	Identifie si le prix de l’offre de produit est un paiement unique ou récurrent. Valeurs valides : Non récurrent Récurrents Type de données : chaîne
Terme de l’offre du produit	Durée du contrat valide pour l’offre de produit. Type de données : chaîne
Spécification du produit	Spécifications du produit. Type de données : objet `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Initial_version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productSpecification.internalId	Initial_version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
productSpecification.internalVersion	Version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.version	External_version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
prodSpecCharValueUse	Caractéristique de l’offre de produit. Type de données : tableau `"prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristicValue	Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau `"productSpecCharacteristicValue": [ { "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.description	Description de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.name	Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
prodSpecCharValueUse.validFor.endDateTime	Date de fin de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail.
valideFor	Plage de dates pour laquelle l’offre de produit est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de l’offre de produit. Type de données : chaîne
validFor.startDateTime	Date de début de l’offre de produit. Type de données : chaîne
version	External_version de l’offre de produit depuis la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Demande cURL

Cet exemple récupère une offre de produit.

curl --location --request GET "https://instance.service-now.com/api/sn_prd_pm_adv/catalogmanagement/productoffering/24413" \
--user 'username':'password'

Corps de réponse :

{
   "id": "24413",
   "name": "Premium SD-WAN Offering New",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2022-01-27 05:41:16",
   "version": "",
   "internalVersion": "2",
   "internalId": "69017a0f536520103b6bddeeff7b127d",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "not_applicable",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-30 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "abc",
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}