Method: orders.patch

Mettre à jour la commande de "3p" à "AOG". Renvoie INVALID_ARGUMENT si l'ID de la commande est vide ou n'est pas égal à une commande existante.

Requête HTTP

PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
orderUpdate.order.merchantOrderId

string

Obligatoire: ID de commande interne attribué au marchand. Cet identifiant doit être unique et est obligatoire pour toute opération ultérieure de mise à jour des commandes. Cet ID peut être défini sur la valeur googleOrderId fournie ou sur toute autre valeur unique. Notez que l'ID présenté aux utilisateurs correspond à userVisibleOrderId, qui peut être une valeur différente et plus conviviale. La longueur maximale autorisée est de 64 caractères.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "header": {
    object (OrderRequestHeader)
  },
  "orderUpdate": {
    "type": enum (Type),
    "order": {
      "googleOrderId": string,
      "userVisibleOrderId": string,
      "userVisibleStateLabel": string,
      "buyerInfo": {
        object (UserInfo)
      },
      "image": {
        object (Image)
      },
      "createTime": string,
      "lastUpdateTime": string,
      "transactionMerchant": {
        object (Merchant)
      },
      "contents": {
        object (Contents)
      },
      "priceAttributes": [
        {
          object (PriceAttribute)
        }
      ],
      "followUpActions": [
        {
          object (Action)
        }
      ],
      "paymentData": {
        object (PaymentData)
      },
      "termsOfServiceUrl": string,
      "note": string,
      "promotions": [
        {
          object (Promotion)
        }
      ],
      "disclosures": [
        {
          object (Disclosure)
        }
      ],
      "vertical": {
        "@type": string,
        field1: ...,
        ...
      },

      // Union field verticals can be only one of the following:
      "purchase": {
        object (PurchaseOrderExtension)
      },
      "ticket": {
        object (TicketOrderExtension)
      }
      // End of list of possible types for union field verticals.
    },
    "updateMask": string,
    "userNotification": {
      object (UserNotification)
    },
    "reason": string
  }
}
Champs
header

object (OrderRequestHeader)

En-tête de la requête de mise à jour de la commande.

orderUpdate.type
(deprecated)

enum (Type)

Obsolète. Utilisez plutôt OrderUpdate.update_mask. Si le type est = SNAPSHOT, OrderUpdate.order doit correspondre à l'intégralité de la commande. Si le type est = ORDER_STATUS, il s'agit de la modification de l'état au niveau de la commande. Seuls order.last_update_time et cet état de secteur sont récupérés. Remarque: type.ORDER_STATUS n'est compatible qu'avec les mises à jour de l'état de PurcahaseOrderExtension et il n'est pas prévu d'étendre cette compatibilité. Nous vous recommandons plutôt d'utiliser updateMask, car il est plus générique, extensible et peut être utilisé pour tous les secteurs.

orderUpdate.order.googleOrderId

string

ID de commande attribué par Google.

orderUpdate.order.userVisibleOrderId

string

Identifiant visible par l'utilisateur faisant référence à la commande en cours. Cet identifiant doit correspondre à celui affiché pour cette commande dans d'autres contextes, y compris sur les sites Web, les applications et les e-mails.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

Obsolète: utilisez plutôt l'état OrderExtensions. Libellé visible par l'utilisateur pour l'état de cette commande.

orderUpdate.order.buyerInfo

object (UserInfo)

Des informations sur l'acheteur.

orderUpdate.order.image

object (Image)

Image associée à la commande.

orderUpdate.order.createTime

string (Timestamp format)

Obligatoire: date et heure de création de la commande.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z"

orderUpdate.order.lastUpdateTime

string (Timestamp format)

Date et heure de la dernière mise à jour de la commande. Obligatoire pour OrderUpdate.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z"

orderUpdate.order.transactionMerchant

object (Merchant)

Marchand ayant facilité le règlement. Il peut s'agir d'un fournisseur au niveau de l'élément de campagne. Exemple: Commande Expedia avec un élément de campagne d'ANA.

orderUpdate.order.contents

object (Contents)

Obligatoire: contenu de la commande, qui correspond à un groupe d'articles.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Prix, remises, taxes, etc.

orderUpdate.order.followUpActions[]

object (Action)

Actions de suivi au niveau de la commande

orderUpdate.order.paymentData

object (PaymentData)

Données de paiement pour la commande.

orderUpdate.order.termsOfServiceUrl

string

Lien vers les conditions d'utilisation qui s'appliquent à la commande/commande proposée.

orderUpdate.order.note

string

Notes associées à une commande.

orderUpdate.order.promotions[]

object (Promotion)

Toutes les promotions associées à cette commande.

orderUpdate.order.disclosures[]

object (Disclosure)

Divulgations associées à cette ordonnance.

orderUpdate.order.vertical
(deprecated)

object

Obsolète: utilisez plutôt des secteurs. Ces propriétés s'appliqueront à tous les éléments de campagne, sauf si vous les remplacez dans certains d'entre eux. Ce secteur doit correspondre au type de secteur au niveau de l'élément de campagne. Valeurs possibles: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

orderUpdate.updateMask

string (FieldMask format)

Remarque: Nous tenons compte des éléments suivants (et recommandations) concernant les champs spéciaux suivants: 1. La valeur order.last_update_time sera toujours mise à jour dans le cadre de la demande de mise à jour. 2. Les champs order.create_time, order.google_order_id et order.merchant_order_id seront ignorés si vous les renseignez dans le champ updateMask.

Liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

orderUpdate.userNotification

object (UserNotification)

Si spécifié, affiche une notification à l'utilisateur avec le titre et le texte spécifiés. La spécification d'une notification est une suggestion d'envoi de notification. Il n'est pas garanti qu'une notification aboutisse.

orderUpdate.reason

string

Motif de la modification/mise à jour.

Champ d'union verticals. Ces propriétés s'appliqueront à tous les éléments de campagne, sauf si vous les remplacez dans certains d'entre eux. Ce secteur doit correspondre au type de secteur au niveau de l'élément de campagne. verticals ne peut être qu'un des éléments suivants :
orderUpdate.order.purchase

object (PurchaseOrderExtension)

Bon de commande

orderUpdate.order.ticket

object (TicketOrderExtension)

Commande de billets

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Order.

OrderUpdate

Mettre à jour une commande

Représentation JSON
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Champs
type
(deprecated)

enum (Type)

Obsolète. Utilisez plutôt OrderUpdate.update_mask. Si le type est = SNAPSHOT, OrderUpdate.order doit correspondre à l'intégralité de la commande. Si le type est = ORDER_STATUS, il s'agit de la modification de l'état au niveau de la commande. Seuls order.last_update_time et cet état de secteur sont récupérés. Remarque: type.ORDER_STATUS n'est compatible qu'avec les mises à jour de l'état de PurcahaseOrderExtension et il n'est pas prévu d'étendre cette compatibilité. Nous vous recommandons plutôt d'utiliser updateMask, car il est plus générique, extensible et peut être utilisé pour tous les secteurs.

order

object (Order)

updateMask

string (FieldMask format)

Remarque: Nous tenons compte des éléments suivants (et recommandations) concernant les champs spéciaux suivants: 1. La valeur order.last_update_time sera toujours mise à jour dans le cadre de la demande de mise à jour. 2. Les champs order.create_time, order.google_order_id et order.merchant_order_id seront ignorés si vous les renseignez dans le champ updateMask.

Liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

userNotification

object (UserNotification)

Si spécifié, affiche une notification à l'utilisateur avec le titre et le texte spécifiés. La spécification d'une notification est une suggestion d'envoi de notification. Il n'est pas garanti qu'une notification aboutisse.

reason

string

Motif de la modification/mise à jour.

Type

Obsolète. Utilisez plutôt OrderUpdate.update_mask. A autorisé les mises à jour d'une commande.

Enums
TYPE_UNSPECIFIED Type non spécifié, ne doit pas être défini explicitement.
ORDER_STATUS Ne met à jour que l'état de la commande.
SNAPSHOT Mettre à jour l'instantané de la commande.

UserNotification

Notification utilisateur facultative à afficher dans le cadre de la mise à jour de la commande.

Représentation JSON
{
  "title": string,
  "text": string
}
Champs
title

string

Titre de la notification utilisateur. La longueur maximale autorisée est de 30 caractères.

text

string

Contenu de la notification. La longueur maximale autorisée est de 100 caractères.