API de commande
L’API de commande fournit des points de terminaison pour la récupération et la création de commandes avec des éléments de ligne de commande pour l’applicationGestion du service client.
Cette API nécessite l’application du Gestion des commandes magasin (app-csm-order-mgmt) et est fournie dans l’espace de noms sn_ind_tmt_orm . (pour en savoir plus, consultez Sales and Order Management) ;
- sn_csm_om.consumer_agent : accès en écriture à l’API limité aux commandes B2C.
- sn_csm_om.customer_agent : accès en écriture à l’API limité aux commandes B2B.
- sn_csm_om.order_admin – Accès en écriture à l’API pour les commandes B2B ou B2C.
Pour plus d’informations sur les commandes B2B et B2C, consultez Modèles de données client pour B2B2C.
API de commande : GET /sn_ind_tmt_orm/order/{id}
Récupère les détails complets de la commande en spécifiant la sys_id ou le numéro de commande.
Format d'URL
URL versionnée : /api/sn_ind_tmt_orm/{api_version}/order/{id}
URL par défaut : /api/sn_ind_tmt_orm/order/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| id | Sys_id ou numéro d’ordre (order_id) de l’enregistrement à récupérer. Type de données : chaîne Table : Commandes [sn_csm_om_order] |
| Nom | Description |
|---|---|
| sysparm_display_value | Marqueur indiquant s’il faut afficher ou non la valeur d’affichage des champs de référence. Valeurs valides :
Valeur par défaut : false |
| Nom | Description |
|---|---|
| Aucun |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
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é correctement traitée. |
| 401 | L’utilisateur n’est pas authentifié. |
| 403 | L’utilisateur n’est pas autorisé.
Cette API nécessite l’accès à sn_csm_om.order_integrator, ainsi que l’un des éléments suivants :
|
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| compte | Sys_id d’un enregistrement situé dans la table Comptes [customer_account]. Identifie le compte pour les commandes B2B. Type de données : chaîne |
| actual_end_date | Date de fin de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| actual_start_date | Date de début de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| billing_city | Nom de la ville de facturation. Type de données : chaîne |
| billing_country | Abréviation du pays de facturation. Type de données : chaîne |
| billing_state | Abréviation de l’état ou de la province de facturation. Type de données : chaîne |
| billing_street | Adresse postale de facturation. Type de données : chaîne |
| billing_zip | Zip/code postal de facturation. Type de données : chaîne |
| commentaires | Informations supplémentaires pour la commande. Type de données : chaîne |
| consommateur | Sys_id d’un enregistrement de consommateur. Identifie le consommateur pour les commandes B2C. Type de données : chaîne |
| contact | Sys_id du contact client associé au compte. Type de données : chaîne Tableau : Contacts [customer_contact] |
| contrat | Sys_id de l’enregistrement Service client du contrat. Type de données : chaîne Table : Contrats [ast_contract] |
| erreur | Détails décrivant une erreur rencontrée pendant le processus de demande. Type de données : objet |
| erreur.détail | Détails de l’erreur rencontrée pendant le processus de demande. Type de données : chaîne |
| message.erreur | Message pour l’erreur rencontrée pendant le processus de demande. Chaque message d’erreur a une description correspondante dans la detail propriété. Type de données : chaîne |
| expected_end_date | Date de fin prévue de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| expected_start_date | Date de début prévue de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| external_id | ID externe représentant un enregistrement connexe sur le système d’un tiers. Type de données : chaîne |
| external_system | Nom du système du client. Type de données : chaîne |
| order_category | Type de commande de client. Valeurs possibles :
Type de données : chaîne |
| order_currency | Code de devise représentant la devise dans laquelle la commande a été achetée. Par exemple, USD pour les dollars américains. Cette devise est utilisée pour tous les champs de montant dans les commandes de commandes et de lignes. Les codes de devise sont répertoriés dans la table Devises [fx_currency]. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_date | Date et heure de la création de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| order_id | Numéro de commande de la commande. Type de données : chaîne Table : Commandes [sn_csm_om_order] |
| order_line_items | Requis. Liste des objets qui définissent chaque élément de ligne de commande dans la commande. Type de données : tableau Propriétés requises dans chaque objet d’élément de ligne de commande :
Table : Éléments de ligne de commande [sn_csm_om_order_line_item] |
| order_line_items | Liste des objets qui définissent chaque élément de ligne de commande dans la commande. Type de données : tableau d’objets
|
| order_line_items.compte | Requis pour les commandes B2B. Sys_id du compte professionnel affecté à cet élément de ligne de bon de commande. Situé dans la table Comptes [customer_account]. La propriété consommateur est requise pour les commandes B2C. Type de données : chaîne |
| order_line_items.compte | Sys_id du compte professionnel affecté à cet élément de ligne de bon de commande. Situé dans la table Comptes [customer_account]. Type de données : chaîne |
| order_line_items.action | Action qui détermine comment la ligne de commande est ajoutée à la commande. Valeurs possibles :
Type de données : chaîne |
| order_line_items.commentaires | Informations supplémentaires pour l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.consommateur | Sys_id du consommateur affecté à cet élément de ligne de commande. Situé dans la table Consommateurs [csm_consumer]. Type de données : chaîne |
| order_line_items.contact | Les sys_id de contact associés au compte. Type de données : chaîne |
| order_line_items.quantité_livrée. | Nombre d’éléments de la commande livrés. Type de données : chaîne |
| order_line_items.date_effective | Date d’entrée en vigueur de la ligne de commande. Format : aaaa-MM-jj HH :mm :ss dans le fuseau horaire UTC Type de données : chaîne |
| order_line_items.expiration_date | Date d’expiration de la ligne de commande. Format : aaaa-MM-jj HH :mm :ss dans le fuseau horaire UTC Type de données : chaîne |
| order_line_items.identificateur_externe | ID externe de l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.système_externe. | sys_id externe de l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.prix_liste | Prix catalogue de l’offre de produits par unité. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_line_items.emplacement | Sys_id d’enregistrement d’un emplacement d’expédition. Type de données : chaîne Table : Emplacements [cmn_location] |
| order_line_items.commande | Numéro de commande de cet élément de ligne, tel qu’il figure dans le tableau Commandes [sn_csm_om_order]. Type de données : chaîne |
| order_line_items. order_line_characteristics | Liste des objets définissant les caractéristiques de ligne de commande associées. Les caractéristiques de ligne de commande figurent dans la table Caractéristiques de ligne de commande [sn_csm_om_order_characteristic_value]. Type de données : tableau d’objets
|
| order_line_items.order_line_characteristics.characteristic_option | Option unique de la caractéristique du produit qui déclenche la règle d’exclusion. Par exemple, la taille ou la couleur du produit. Type de données : chaîne |
| order_line_items. order_line_characteristics. characteristic_option_value | Valeur d’une option de caractéristique. Type de données : chaîne |
| order_line_items. order_line_characteristics. external_id | ID externe de la caractéristique de la ligne de commande. Type de données : objet |
| order_line_items. order_line_characteristics.numéro | Numéro de caractéristique de ligne de commande Type de données : chaîne Table : Caractéristiques de ligne de commande [sn_csm_om_order_characteristic_value] |
| order_line_items. order_line_characteristics. order_line_item | Sys_id de l’élément de ligne de commande de cette caractéristique. Type de données : chaîne Table : Éléments de ligne de commande [sn_csm_om_order_line_item] |
| order_line_items. order_line_characteristics. previous_characteristic_option_value | Nom de l’option de caractéristique précédente associée au modèle de produit dans la ligne de commande. Type de données : objet |
| order_line_items. order_line_characteristics.spécification | Spécification de service associée à la caractéristique de la commande de service. Type de données : chaîne |
| order_line_items. order_line_characteristics. sys_class_name | Nom du système de la table dans laquelle se trouve cet enregistrement de caractéristique de ligne de commande. Type de données : chaîne |
| order_line_characteristics. sys_created_by | Nom du système de l’utilisateur qui a créé cet enregistrement. Type de données : chaîne |
| order_line_items. order_line_characteristics. sys_created_on | Date et heure de création initiales de l’enregistrement. Type de données : chaîne |
| order_line_items. order_line_characteristics. sys_domain | Champ d’application de domaine dans lequel l’enregistrement de commande est accessible. Par exemple, global. Type de données : chaîne |
| order_line_items. order_line_characteristics. sys_domain_path | Chemin de domaine pour l’enregistrement. Type de données : chaîne Par défaut : / (global) |
| order_line_items. order_line_characteristics. sys_id | Sys_id de l’enregistrement de commande Type de données : chaîne Table : Caractéristiques de ligne de commande [sn_csm_om_order_characteristic_value] |
| order_line_items. order_line_characteristics. sys_mod_count | Nombre de modifications de cet enregistrement. Type de données : chaîne |
| order_line_items. order_line_characteristics. sys_tags | Balises système pour le contenu. Type de données : chaîne |
| order_line_items. order_line_characteristics. sys_updated_by | Nom du système de l’utilisateur qui a récemment mis à jour cet enregistrement. Type de données : chaîne |
| order_line_items. order_line_characteristics. sys_updated_on | Date et heure de dernière mise à jour de l’enregistrement. Type de données : chaîne |
| order_line_items. order_line_characteristics.type | Type de caractéristique de ligne de commande. Valeurs possibles :
Type de données : chaîne |
| order_line_items.ID_ligne_de_commande | Numéro de commande de la commande associée à cet élément de ligne de commande. Type de données : chaîne |
| order_line_items.élément_ligne_parent | Le cas échéant, identifie un élément de ligne parent de cet élément de ligne. Type de données : chaîne |
| order_line_items.modèle_produit_précédent | Sys_id du modèle de produit pour le produit répertorié avant cet élément dans la ligne de commande. Type de données : chaîne Table : modèles de produits [cmdb_model] |
| order_line_items.liste_prix | Sys_id d’un enregistrement de liste de prix dans la table Listes de prix [sn_csm_pricing_price_list]. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_line_items.produit | Sys_id du produit Type de données : chaîne Table : modèles de produits [cmdb_model] |
| order_line_items.offre_produit | Sys_id du produit répertorié dans la table Offres de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| order_line_items.produit | Sys_id du modèle de produit répertorié dans la table Modèles de produits [cmdb_model]. Doit être fourni avec l’élément de ligne de commande correspondant Type de données : chaîne |
| order_line_items.spécification_du_produit | Sys_id de la spécification du produit associée à l’élément de ligne de bon de commande. Répertorié dans le tableau Spécifications de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| order_line_items.quantité | Nombre de modèles de produits commandés. Type de données : chaîne |
| order_line_items.ville_livraison | Nom de la ville de destination. Type de données : chaîne |
| order_line_items.pays_livraison | Abréviation du pays de destination. Type de données : chaîne |
| order_line_items.état_livraison | Abréviation de l’État ou de la province de destination. Type de données : chaîne |
| order_line_items.rue_livraison | Adresse postale de destination. Type de données : chaîne |
| order_line_items.shipping_zip | Code postal de destination. Type de données : chaîne |
| order_line_items.description_courte | Brève description de l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.sku | Nombre généré par un fournisseur qui identifie de manière unique un produit qu'il vend. Type de données : chaîne |
| order_line_items.produit_vendu | Sys_id d’enregistrement d’un produit vendu de base d’installation. Type de données : chaîne Table : produits vendus [sn_install_base_sold_product] |
| order_line_items.spécification | Spécification de l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.état | État de la ligne de commande. Par exemple, Brouillon, Nouveau, in_progress ou Terminé. Type de données : chaîne |
| order_line_items.statut | État de l’élément de ligne de bon de commande. Valeurs possibles :
Type de données : chaîne |
| nom_classe_order_line_items.sys | Nom du système de la table dans laquelle se trouve cet enregistrement d’élément de ligne de commande. Type de données : chaîne |
| order_line_items.sys_created_by | Nom du système de l’utilisateur qui a créé cet enregistrement. Type de données : chaîne |
| order_line_items.sys_created_on | Date et heure de création initiales de l’enregistrement. Type de données : chaîne |
| order_line_items.sys_domaine | Champ d’application de domaine dans lequel l’enregistrement de commande est accessible. Par exemple, global. Type de données : chaîne |
| order_line_items.sys_chemin_domaine | Chemin de domaine pour l’enregistrement. Type de données : chaîne Par défaut : / (global) |
| order_line_items.sys_id | Sys_id de l’enregistrement de l’élément de ligne Type de données : chaîne Table : Éléments de ligne de commande [sn_csm_om_order_line_item] |
| order_line_items.sys_mod_count | Nombre de modifications de cet enregistrement. Type de données : chaîne |
| order_line_items.sys_balises | Balises système pour le contenu. Type de données : chaîne |
| order_line_items.sys_updated_by | Nom du système de l’utilisateur qui a récemment mis à jour cet enregistrement. Type de données : chaîne |
| order_line_items.sys_updated_on | Date et heure de dernière mise à jour de l’enregistrement. Type de données : chaîne |
| order_line_items.élément_ligne_supérieur | Prix total de tous les éléments de ligne de commande accumulés dans cette commande. Type de données : chaîne |
| order_line_items.prix_total | Prix total de la ligne de commande. L’API ne calcule pas le total en fonction du prix net et de la quantité. Type de données : chaîne |
| order_line_items.unité_de_mesure | Sys_id de l’unité de mesure commandée répertoriée dans le tableau Unité de mesures [sn_prd_pm_uom]. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_line_items.unit_of_measurement | Requis. Sys_id de l’unité de mesure commandée répertoriée dans le tableau Unité de mesures [sn_prd_pm_uom]. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_line_items.prix_unitaire | Prix net de l’offre de produits par unité. Type de données : chaîne Table : Instances de devises [fx_currency_instance] |
| order_line_items.notes_de_travail | Notes de travail internes de forme libre pour l’élément de ligne de bon de commande. Type de données : chaîne |
| order_type | Action de commande qui détermine comment la commande est ajoutée. Valeurs possibles :
Type de données : chaîne |
| partenaire | Pour les commandes B2B, sys_id de l’enregistrement du partenaire associé pour un compte. Type de données : chaîne Table : comptes [customer_account] |
| partner_contact | Pour les commandes B2B, sys_id du contact principal du partenaire pour le compte partenaire. Type de données : chaîne Tableau : Contacts [customer_contact] |
| payment_ref_id | Identificateur unique du paiement. Par exemple, vérifiez le numéro. Type de données : chaîne |
| price_list | Sys_id de l’enregistrement de la liste de prix associée. Le prix n’est pas calculé en fonction du prix net et de la quantité par cette API. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne Tableau : Listes de prix [sn_csm_pricing_price_list] |
| quote_id | ID unique pour le devis de prix de la commande. Type de données : chaîne |
| same_as_shipping_address | Marqueur indiquant si l’adresse de l’acheteur est la même que l’adresse d’expédition. Valeurs valides :
Type de données : booléennes |
| shipping_city | Nom de la ville de destination. Type de données : chaîne |
| shipping_country | Abréviation du pays de destination. Type de données : chaîne |
| shipping_location | Sys_id d’enregistrement d’un emplacement d’expédition. Type de données : chaîne Table : Emplacements [cmn_location] |
| shipping_state | Abréviation de l’État ou de la province de destination. Type de données : chaîne |
| shipping_street | Adresse postale de destination. Type de données : chaîne |
| shipping_zip | Code postal de destination. Type de données : chaîne |
| short_description | Brève description de la commande. Type de données : chaîne |
| special_instructions | Instructions spéciales pour la commande. Type de données : chaîne |
| État | État de la commande. Par exemple, nouveau, in_progress ou terminé. Type de données : chaîne |
| état | État de la commande. Valeurs possibles :
Type de données : chaîne |
| sys_class_name | Nom du système de la table dans laquelle se trouve cet enregistrement de commande. Type de données : chaîne |
| sys_created_by | Nom du système de l’utilisateur qui a créé cet enregistrement. Type de données : chaîne |
| sys_created_on | Date et heure de création initiales de l’enregistrement. Type de données : chaîne |
| sys_domain | Champ d’application de domaine dans lequel l’enregistrement de commande est accessible. Par exemple, global. Type de données : chaîne |
| sys_domain_path | Chemin de domaine pour l’enregistrement. Type de données : chaîne Par défaut : / (global) |
| sys_id | Sys_id de l’enregistrement de la commande. Type de données : chaîne Table : Commandes [sn_csm_om_order] |
| sys_mod_count | Nombre de modifications de cet enregistrement. Type de données : chaîne |
| sys_tags | Balises système pour le contenu. Type de données : chaîne |
| sys_updated_by | Nom du système de l’utilisateur qui a récemment mis à jour cet enregistrement. Type de données : chaîne |
| sys_updated_on | Date et heure de dernière mise à jour de l’enregistrement. Type de données : chaîne |
| total_amount | Coût total pour l’ensemble de la commande. Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment obtenir une commande par son numéro de commande.
curl "https://instance.service-now.com/api/sn_ind_tmt_orm/order/ORD0001034" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Réponse :
{
"result": {
"actual_start_date": "",
"payment_ref_id": null,
"shipping_city": null,
"channel": "api",
"expected_end_date": "",
"sys_updated_on": "2022-03-30 21:59:41",
"price_list": null,
"sys_updated_by": "username",
"sys_created_on": "2022-03-30 21:59:41",
"contact": "96d0461553ab70101aaeddeeff7b120b",
"sys_domain": "global",
"state": "draft",
"order_type": "add",
"sys_created_by": "eseruser",
"shipping_street": null,
"special_instructions": null,
"contract": null,
"quote_id": null,
"expected_start_date": "",
"sys_domain_path": "/",
"billing_street": null,
"billing_city": null,
"total_amount": "2000",
"order_id": "ORD0001034",
"shipping_country": "USA",
"status": "new",
"short_description": null,
"shipping_state": null,
"external_id": null,
"sys_class_name": "sn_csm_om_order",
"sys_id": "24fdf5bd75eec510f877f30c01a15aa0",
"shipping_zip": null,
"billing_state": null,
"billing_zip": null,
"same_as_shipping_address": "0",
"consumer": null,
"comments": "",
"order_currency": "USD",
"billing_country": "USA",
"sys_mod_count": "1",
"billing_location": null,
"shipping_location": null,
"sys_tags": "",
"order_date": "2022-03-30 21:59:41",
"order_category": "product",
"actual_end_date": "",
"partner": null,
"partner_contact": null,
"account": "c480021553ab70101aaeddeeff7b120f",
"external_system": null,
"order_line_items": [
{
"short_description": null,
"shipping_state": "CA",
"shipping_city": "Santa Clara",
"product_offering": "2d4376760f740110603bf634a7767e46",
"external_id": null,
"sys_updated_on": "2022-03-30 21:59:41",
"expiration_date": "",
"sys_class_name": "sn_csm_om_order_line_item",
"sold_product": null,
"sys_id": "ecfdf5bd75eec510f877f30c01a15aa3",
"unit_of_measurement": "cb2795d553020110286eddeeff7b12ff",
"price_list": null,
"sys_updated_by": "username",
"shipping_zip": "94560",
"sys_created_on": "2022-03-30 21:59:41",
"contact": "96d0461553ab70101aaeddeeff7b120b",
"sys_domain": "global",
"effective_date": "",
"action": "add",
"order_line_id": "ORDL0001060",
"state": "draft",
"sku": null,
"consumer": null,
"sys_created_by": "username",
"order": "24fdf5bd75eec510f877f30c01a15aa0",
"previous_product_model": null,
"shipping_street": "222 Star St",
"product": "561dba7e0f740110603bf634a7767ebe",
"quantity": "1",
"comments": "",
"total_price": "2000",
"parent_line_item": null,
"sys_mod_count": "1",
"specification": "104f66720f740110603bf634a7767e7d",
"list_price": "2000",
"unit_price": "2000",
"sys_domain_path": "/",
"sys_tags": "",
"delivered_quantity": null,
"top_line_item": null,
"product_specification": "104f66720f740110603bf634a7767e7d",
"location": null,
"work_notes": "",
"shipping_country": "USA",
"account": "c480021553ab70101aaeddeeff7b120f",
"external_system": null,
"status": "new",
"order_line_characteristics": [
{
"characteristic_option": "1c6ceabe0f340110603bf634a7767e97",
"sys_mod_count": "0",
"specification": "104f66720f740110603bf634a7767e7d",
"external_id": null,
"sys_updated_on": "2022-03-30 21:59:41",
"type": "1",
"sys_domain_path": "/",
"sys_tags": "",
"characteristic": "4e76f1b20fb00110603bf634a7767ee3",
"sys_class_name": "sn_csm_om_order_characteristic_value",
"previous_characteristic_option_value": null,
"number": "ORC000001041",
"sys_id": "acfd79bd75eec510f877f30c01a15a94",
"sys_updated_by": "username",
"sys_created_on": "2022-03-30 21:59:41",
"sys_domain": "global",
"characteristic_option_value": "1.2 cu",
"order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
"sys_created_by": "user"
},
{
"characteristic_option": "2d0d66fe0f340110603bf634a7767ef6",
"sys_mod_count": "0",
"specification": "104f66720f740110603bf634a7767e7d",
"external_id": null,
"sys_updated_on": "2022-03-30 21:59:41",
"type": "1",
"sys_domain_path": "/",
"sys_tags": "",
"characteristic": "11e639b20fb00110603bf634a7767e17",
"sys_class_name": "sn_csm_om_order_characteristic_value",
"previous_characteristic_option_value": null,
"number": "ORC000001042",
"sys_id": "e0fd79bd75eec510f877f30c01a15a95",
"sys_updated_by": "username",
"sys_created_on": "2022-03-30 21:59:41",
"sys_domain": "global",
"characteristic_option_value": "Stainless steel",
"order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
"sys_created_by": "user"
}
]
}
]
}
}
API de commande : POST /sn_ind_tmt_orm/order
Crée une nouvelle commande avec des éléments de ligne et des caractéristiques.
- account pour les commandes B2B ou consumer pour les commandes B2C.
- account – Sys_id d’un enregistrement situé dans la table Comptes [customer_account].
- consumer – Sys_id d’un enregistrement de consommateur.
- order_currency – Code de devise représentant la devise dans laquelle la commande a été achetée. Par exemple, USD pour les dollars américains. Cette devise est utilisée pour tous les champs de montant dans les commandes de commandes et de lignes. Les codes de devise sont répertoriés dans la table Devises [fx_currency].
- order_line_items – Liste des objets qui définissent chaque élément de ligne de commande dans la commande. Propriétés requises dans chaque objet d’élément de ligne de commande :
- account pour les commandes B2B ou consumer pour les commandes B2C.
- account – Sys_id du compte professionnel affecté à cet élément de ligne de bon de commande. Situé dans la table Comptes [customer_account].
- consumer – Sys_id du consommateur affecté à cet élément de ligne de commande. Situé dans la table Consommateurs [csm_consumer].
- order_line_characteristics – Liste des objets définissant les caractéristiques de ligne de commande associées. Les caractéristiques de ligne de commande figurent dans la table Caractéristiques de ligne de commande [sn_csm_om_order_characteristic_value].
- product_offering – Sys_id du produit répertorié dans la table Offres de produits [sn_prd_pm_product_offering].
- quantity – Nombre de modèles de produits commandés.
- unit_of_measurements – Sys_id de l’unité de mesure commandée répertoriée dans le tableau Unité de mesures [sn_prd_pm_uom].
- account pour les commandes B2B ou consumer pour les commandes B2C.
La table Paramètres du corps de la demande contient plus de détails.
Format d'URL
URL versionnée : /api/sn_ind_tmt_orm/{api_version}/order
URL par défaut : /api/sn_ind_tmt_orm/order
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| compte | Requis pour les commandes B2B. Sys_id d’un enregistrement situé dans la table Comptes [customer_account]. La propriété consommateur est requise pour les commandes B2C. Type de données : chaîne |
| actual_end_date | Date de fin de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| actual_start_date | Date de début de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| billing_city | Nom de la ville de facturation. Type de données : chaîne |
| billing_country | Abréviation du pays de facturation. Type de données : chaîne |
| billing_state | Abréviation de l’état ou de la province de facturation. Type de données : chaîne |
| billing_street | Adresse postale de facturation. Type de données : chaîne |
| billing_zip | Zip/code postal de facturation. Type de données : chaîne |
| commentaires | Informations supplémentaires pour la commande. Type de données : chaîne |
| consommateur | Requis pour les commandes B2C. Sys_id d’un enregistrement de consommateur. La propriété du compte est requise pour les commandes B2B. Type de données : chaîne Table : Consommateurs [csm_consumer] |
| contact | Sys_id du contact client associé au compte. Type de données : chaîne Tableau : Contacts [customer_contact] |
| contrat | Sys_id de l’enregistrement Service client du contrat. Type de données : chaîne Table : Contrats [ast_contract] |
| expected_end_date | Date de fin prévue de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| expected_start_date | Date de début prévue de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| external_id | ID externe représentant un enregistrement connexe sur le système d’un tiers. Type de données : chaîne |
| external_system | Nom du système du client. Type de données : chaîne |
| order_category | Type de commande de client. Valeurs possibles :
Type de données : chaîne |
| order_currency | Requis. Code de devise représentant la devise dans laquelle la commande a été achetée. Par exemple, USD pour les dollars américains. Cette devise est utilisée pour tous les champs de montant dans les commandes de commandes et de lignes. Les codes de devise sont répertoriés dans la table Devises [fx_currency]. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_date | Date et heure de la création de la commande. Format : format UTC, aaaa-MM-jj HH :mm :ss Type de données : chaîne |
| order_line_items | Requis. Liste des objets qui définissent chaque élément de ligne de commande dans la commande. Type de données : tableau Propriétés requises dans chaque objet d’élément de ligne de commande :
Table : Éléments de ligne de commande [sn_csm_om_order_line_item] |
| order_line_items.compte | Requis pour les commandes B2B. Sys_id du compte professionnel affecté à cet élément de ligne de bon de commande. Situé dans la table Comptes [customer_account]. La propriété consommateur est requise pour les commandes B2C. Type de données : chaîne |
| order_line_items.action | Action qui détermine comment la ligne de commande est ajoutée à la commande. Valeurs possibles :
Type de données : chaîne |
| order_line_items.commentaires | Informations supplémentaires pour l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.consommateur | Requis pour les commandes B2C. Sys_id du consommateur affecté à cet élément de ligne de commande. Situé dans la table Consommateurs [csm_consumer]. La propriété du compte est requise pour les commandes B2B. Type de données : chaîne |
| order_line_items.contact | Les sys_id de contact associés au compte. Type de données : chaîne |
| order_line_items.quantité_livrée. | Nombre d’éléments de la commande livrés. Type de données : chaîne |
| order_line_items.date_effective | Date d’entrée en vigueur de la ligne de commande. Format : aaaa-MM-jj HH :mm :ss dans le fuseau horaire UTC Type de données : chaîne |
| order_line_items.expiration_date | Date d’expiration de la ligne de commande. Format : aaaa-MM-jj HH :mm :ss dans le fuseau horaire UTC Type de données : chaîne |
| order_line_items.identificateur_externe | ID externe de l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.système_externe. | sys_id externe de l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.prix_liste | Prix catalogue de l’offre de produits par unité. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_line_items.order_line_characteristics | Requis. Liste des objets définissant les caractéristiques de ligne de commande associées. Les caractéristiques de ligne de commande figurent dans la table Caractéristiques de ligne de commande [sn_csm_om_order_characteristic_value]. Dans la version la plus récente, si l’offre est associée à une spécification de produit, les caractéristiques de la commande doivent être incluses pour déterminer le modèle de produit. Dans les versions antérieures, cette propriété n’était requise que pour les commandes simples avec la order_line_items.product_specification propriété définie. Type de données : tableau d’objets
|
| order_line_items.order_line_characteristics.caractéristique | Nom de la caractéristique associée au modèle de produit. Par exemple, taille du lave-vaisselle. Type de données : chaîne |
| order_line_items.order_line_characteristics.characteristic_option | Option unique de la caractéristique du produit qui déclenche la règle d’exclusion. Par exemple, la taille ou la couleur du produit. Type de données : chaîne |
| order_line_items.liste_prix | Sys_id d’un enregistrement de liste de prix dans la table Listes de prix [sn_csm_pricing_price_list]. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_line_items.produit | Sys_id du modèle de produit répertorié dans la table Modèles de produits [cmdb_model]. Si elles sont incluses dans le corps de la demande, les caractéristiques de ligne de commande associées doivent correspondre. Type de données : chaîne |
| order_line_items.offre_produit | Requis. Sys_id du produit répertorié dans la table Offres de produits [sn_prd_pm_product_offering]. Si l’offre est associée au modèle de produit, le modèle de produit est déterminé par la commande. Si l’offre est associée à une spécification de produit, les caractéristiques de la commande doivent être incluses pour déterminer le modèle de produit. Type de données : chaîne |
| order_line_items.product_specification | Requis. Sys_id de la spécification du produit associée à l’élément de ligne de bon de commande. Répertorié dans le tableau Spécifications de produit [sn_prd_pm_product_specification]. Remarque :
Cette propriété n’était pas requise dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_line_items.quantité | Requis. Nombre de modèles de produits commandés. Remarque : Cette propriété était requise dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_line_items.ville_livraison | Nom de la ville de destination. Type de données : chaîne |
| order_line_items.pays_livraison | Abréviation du pays de destination. Type de données : chaîne |
| order_line_items.état_livraison | Abréviation de l’État ou de la province de destination. Type de données : chaîne |
| order_line_items.rue_livraison | Adresse postale de destination. Type de données : chaîne |
| order_line_items.shipping_zip | Code postal de destination. Type de données : chaîne |
| order_line_items.description_courte | Brève description de l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.sku | Nombre généré par un fournisseur qui identifie de manière unique un produit qu'il vend. Type de données : chaîne |
| order_line_items.produit_vendu | Sys_id d’enregistrement d’un produit vendu de base d’installation. Type de données : chaîne Table : produits vendus [sn_install_base_sold_product] |
| order_line_items.spécification | Spécification de l’élément de ligne de bon de commande. Type de données : chaîne |
| order_line_items.état | État de la ligne de commande. Par exemple, Brouillon, Nouveau, in_progress ou Terminé. Type de données : chaîne |
| order_line_items.prix_total | Prix total de la ligne de commande. Le prix total n’est pas calculé en fonction du prix net et de la quantité par cette API. Type de données : chaîne |
| order_line_items.unit_of_measurement | Requis. Sys_id de l’unité de mesure commandée répertoriée dans le tableau Unité de mesures [sn_prd_pm_uom]. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne |
| order_line_items.prix_unitaire | Prix net de l’offre de produits par unité. Type de données : chaîne Table : Instances de devises [fx_currency_instance] |
| order_line_items.notes_de_travail | Notes de travail internes de forme libre pour l’élément de ligne de bon de commande. Type de données : chaîne |
| order_type | Action de commande qui détermine comment la commande est ajoutée. Valeurs possibles :
Type de données : chaîne |
| partenaire | Pour les commandes B2B, sys_id de l’enregistrement du partenaire associé pour un compte. Type de données : chaîne Table : comptes [customer_account] |
| partner_contact | Pour les commandes B2B, sys_id du contact principal du partenaire pour le compte partenaire. Type de données : chaîne Tableau : Contacts [customer_contact] |
| price_list | Sys_id de l’enregistrement de la liste de prix associée. Le prix n’est pas calculé en fonction du prix net et de la quantité par cette API. Remarque : Cette propriété peut ne pas être disponible dans les versions antérieures de Gestion des commandes. Type de données : chaîne Tableau : Listes de prix [sn_csm_pricing_price_list] |
| quote_id | ID unique pour le devis de prix de la commande. Type de données : chaîne |
| shipping_city | Nom de la ville de destination. Type de données : chaîne |
| shipping_country | Abréviation du pays de destination. Type de données : chaîne |
| shipping_state | Abréviation de l’État ou de la province de destination. Type de données : chaîne |
| shipping_street | Adresse postale de destination. Type de données : chaîne |
| shipping_zip | Code postal de destination. Type de données : chaîne |
| short_description | Brève description de la commande. Type de données : chaîne |
| special_instructions | Instructions spéciales pour la commande. Type de données : chaîne |
| État | État de la commande. Par exemple, nouveau, in_progress ou terminé. Type de données : chaîne |
| total_amount | Coût total pour l’ensemble de la commande. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
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é correctement traitée. |
| 400 | Demande incorrecte. La charge utile n’est pas au format attendu. |
| 401 | L’utilisateur n’est pas authentifié. |
| 403 | L’utilisateur n’est pas autorisé.
Cette API nécessite l’accès à sn_csm_om.order_integrator, ainsi que l’un des éléments suivants :
|
| 500 | Erreur interne du serveur. Une ou plusieurs validations ont échoué. Problèmes possibles :
|
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Détails décrivant une erreur rencontrée pendant le processus de demande. Type de données : objet |
| erreur.détail | Détails de l’erreur rencontrée pendant le processus de demande. Type de données : chaîne |
| message.erreur | Message pour l’erreur rencontrée pendant le processus de demande. Chaque message d’erreur a une description correspondante dans la detail propriété. Type de données : chaîne |
| order_id | Numéro de commande de la commande. Type de données : chaîne Table : Commandes [sn_csm_om_order] |
| état | Message d’échec inclus en plus de l’objet d’erreur. Type de données : chaîne |
| sys_id | Sys_id de l’enregistrement de la commande. Type de données : chaîne Table : Commandes [sn_csm_om_order] |
Demande cURL
L’exemple suivant montre comment créer une commande d’article unique pour un four à micro-ondes en acier inoxydable.
curl "https://instance.service-now.com/api/sn_ind_tmt_orm/order" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"account\": \"c480021553ab70101aaeddeeff7b120f\",
\"contact\":\"96d0461553ab70101aaeddeeff7b120b\",
\"order_currency\": \"USD\",
\"order_line_items\": [
{
\"account\": \"c480021553ab70101aaeddeeff7b120f\",
\"action\": \"add\",
\"contact\": \"96d0461553ab70101aaeddeeff7b120b\",
\"list_price\": \"2000\",
\"order_line_characteristics\": [
{
\"characteristic\" : \"Solana color\",
\"characteristic_option\" : \"Stainless steel\"
},
{
\"characteristic\" :\"Microvawe Capacity\",
\"characteristic_option\" : \"1.2 cu\"
}
],
\"product_offering\": \"2d4376760f740110603bf634a7767e46\",
\"quantity\": \"1\",
\"shipping_city\": \"Santa Clara\",
\"shipping_country\": \"USA\",
\"shipping_state\": \"CA\",
\"shipping_street\": \"222 Star St\",
\"shipping_zip\": \"94560\",
\"state\": \"draft\",
\"status\": \"new\",
\"total_price\": \"2000\",
\"unit_of_measurement\": \"cb2795d553020110286eddeeff7b12ff\",
\"unit_price\": \"2000\"
}
]
}" \
--user 'user':'password'
Réponse :
{
"result": {
"sys_id": "24fdf5bd75eec510f877f30c01a15aa0",
"order_id": "ORD0001034"
}
}