- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- OrderUpdate
- Tipo
- UserNotification
Atualizar pedido de 3p para AOG. Retorna INVALID_ ARGUMENT se o ID do pedido estiver vazio ou não for igual a um pedido existente.
Solicitação HTTP
PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
orderUpdate.order.merchantOrderId |
Obrigatório: ID do pedido interno atribuído pelo comerciante. Esse ID precisa ser exclusivo e necessário para as operações de atualização de pedidos subsequentes. Esse ID pode ser definido como o googleOrderId fornecido ou qualquer outro valor exclusivo. O ID apresentado aos usuários é userVisibleOrderId, que pode ser um valor diferente e mais fácil de usar. O comprimento máximo permitido é de 64 caracteres. |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON | |
---|---|
{ "header": { object ( |
Campos | ||
---|---|---|
header |
Cabeçalho da solicitação de atualização do pedido. |
|
orderUpdate.type |
Obsoleto: use OrderUpdate.update_mask. Se o tipo for SNAPSHOT, o OrderUpdate.order deverá ser o pedido inteiro. Se o tipo for igual a ORDER_STATUS, esta é a alteração de status no nível do pedido. Somente pedido.last_update_time e esse status de indústria são extraídos. Observação: type.ORDER_STATUS só é compatível com atualizações de status de PurcahaseOrderExtension. Não há planos de estender esse suporte. Em vez disso, recomendamos o uso de updateMask, já que ele é mais genérico, extensível e pode ser usado para todos os setores. |
|
orderUpdate.order.googleOrderId |
ID do pedido atribuído pelo Google. |
|
orderUpdate.order.userVisibleOrderId |
O ID voltado para o usuário que faz referência ao pedido atual. Esse ID precisa ser consistente com o exibido para esse pedido em outros contextos, incluindo sites, apps e e-mail. |
|
orderUpdate.order.userVisibleStateLabel |
Obsoleto: use o status OrderExtensions. Rótulo visível ao usuário para o estado deste pedido. |
|
orderUpdate.order.buyerInfo |
Informações sobre o comprador. |
|
orderUpdate.order.image |
Imagem associada ao pedido. |
|
orderUpdate.order.createTime |
Obrigatório: data e hora em que o pedido foi criado. É um carimbo de data/hora no formato UTC "Zulu" RFC3339, medido com precisão de nanossegundos. Exemplo: |
|
orderUpdate.order.lastUpdateTime |
Data e hora da última atualização do pedido. Obrigatório para OrderUpdate. É um carimbo de data/hora no formato UTC "Zulu" RFC3339, medido com precisão de nanossegundos. Exemplo: |
|
orderUpdate.order.transactionMerchant |
Comerciante que facilitou a finalização da compra. Ele pode ser diferente de um provedor no nível do item de linha. Exemplo: pedido da Expedia com item de linha da ANA. |
|
orderUpdate.order.contents |
Obrigatório: conteúdo do pedido, que é um grupo de itens de linha. |
|
orderUpdate.order.priceAttributes[] |
Preço, descontos, tributos e assim por diante. |
|
orderUpdate.order.followUpActions[] |
Ações de acompanhamento no nível do pedido. |
|
orderUpdate.order.paymentData |
Dados relacionados ao pagamento do pedido. |
|
orderUpdate.order.termsOfServiceUrl |
Um link para os Termos de Serviço que se aplicam ao pedido/pedido proposto. |
|
orderUpdate.order.note |
Observações anexadas a um pedido. |
|
orderUpdate.order.promotions[] |
Todas as promoções associadas a este pedido. |
|
orderUpdate.order.disclosures[] |
Divulgações associadas a este pedido. |
|
orderUpdate.order.vertical |
Obsoleto: use verticais. Essas propriedades serão aplicadas a todos os itens de linha, a menos que sejam substituídas em algum item de linha. Essa indústria precisa corresponder ao tipo de indústria no nível do item de linha. Valores possíveis: Um objeto contendo campos de um tipo arbitrário. Um campo adicional |
|
orderUpdate.updateMask |
Observação: há as seguintes considerações/recomendações para os seguintes campos especiais: 1. O pedido.last_update_time será sempre atualizado como parte da solicitação de atualização. 2. O order.create_time, o order.google_order_id e o order.merchant_order_id serão ignorados se forem fornecidos como parte da updateMask. Lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
|
orderUpdate.userNotification |
Se especificado, exibe uma notificação para o usuário com o título e o texto especificados. Especificar uma notificação é uma sugestão a ser notificada e não é garantido que ela resulte em uma notificação. |
|
orderUpdate.reason |
Motivo da alteração/atualização. |
|
Campo de união verticals . Essas propriedades serão aplicadas a todos os itens de linha, a menos que sejam substituídas em algum item de linha. Essa indústria precisa corresponder ao tipo de indústria no nível do item de linha. verticals pode ser apenas de um dos tipos a seguir: |
||
orderUpdate.order.purchase |
ordem de compra |
|
orderUpdate.order.ticket |
Pedido de ingresso |
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Order
.
OrderUpdate
Atualizar um pedido.
Representação JSON | |
---|---|
{ "type": enum ( |
Campos | |
---|---|
type |
Obsoleto: use OrderUpdate.update_mask. Se o tipo for SNAPSHOT, o OrderUpdate.order deverá ser o pedido inteiro. Se o tipo for igual a ORDER_STATUS, esta é a alteração de status no nível do pedido. Somente pedido.last_update_time e esse status de indústria são extraídos. Observação: type.ORDER_STATUS só é compatível com atualizações de status de PurcahaseOrderExtension. Não há planos de estender esse suporte. Em vez disso, recomendamos o uso de updateMask, já que ele é mais genérico, extensível e pode ser usado para todos os setores. |
order |
|
updateMask |
Observação: há as seguintes considerações/recomendações para os seguintes campos especiais: 1. O pedido.last_update_time será sempre atualizado como parte da solicitação de atualização. 2. O order.create_time, o order.google_order_id e o order.merchant_order_id serão ignorados se forem fornecidos como parte da updateMask. Lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
userNotification |
Se especificado, exibe uma notificação para o usuário com o título e o texto especificados. Especificar uma notificação é uma sugestão a ser notificada e não é garantido que ela resulte em uma notificação. |
reason |
Motivo da alteração/atualização. |
Tipo
Obsoleto: use OrderUpdate.update_mask. Permissão para atualizações de um pedido.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Tipo não especificado, não deve definir isso explicitamente. |
ORDER_STATUS |
Atualizar apenas o status do pedido. |
SNAPSHOT |
Atualizar resumo do pedido. |
UserNotification
Notificação opcional ao usuário a ser exibida como parte da atualização do pedido.
Representação JSON | |
---|---|
{ "title": string, "text": string } |
Campos | |
---|---|
title |
O título da notificação do usuário. O comprimento máximo permitido é de 30 caracteres. |
text |
O conteúdo da notificação. O comprimento máximo permitido é de 100 caracteres. |