REST Resource: sellers.orders

Recurso: Order

Um pedido é um conjunto de Lines que especifica quando e onde exibir os anúncios.

Representação JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  },
  "cancellationReason": enum (CancellationReason)
}
Campos
name

string

O nome do recurso do pedido. Formato: sellers/{seller}/orders/{order}
externalId

string

Um ID usado para mapear esta entidade para origens externas.
displayName

string

O nome de exibição do pedido.

Precisa ser codificado em UTF-8 com tamanho máximo de 240 bytes.
description

string

Campo de formato livre adicional para descrever o pedido.
state

enum (State)

Apenas saída. O estado do pedido.

O vendedor pode usar os seguintes métodos personalizados: orders.completeOrderReservation ou orders.completeOrderBooking para definir como um dos seguintes:

  • STATE_RESERVATION_COMPLETE
  • STATE_BOOKING_COMPLETE.

Todos os outros estados de pedido são definidos pelo comprador.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de criação do pedido.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da última atualização do pedido.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
advertiserInfo

object (AdvertiserInfo)

Informações do anunciante.
cancellationReason

enum (CancellationReason)

Apenas saída. Motivo do cancelamento.

Estado

O estado do pedido.

Enums
STATE_UNSPECIFIED O valor padrão quando o estado do pedido não foi especificado ou é desconhecido nesta versão.
STATE_PENDING_RESERVATION

O pedido contém:

  • uma ou mais linhas no estado de reserva pendente.
  • zero ou mais linhas no estado reservado.
  • nenhuma linha em todos os outros estados.
STATE_RESERVATION_COMPLETE

O pedido contém:

  • uma ou mais linhas em reservadas ou rejeitadas pelos estados do vendedor.
  • nenhuma linha em todos os outros estados.
STATE_PENDING_BOOKING

O pedido contém:

  • uma ou mais linhas em reserva pendente ou recusadas pelos estados do vendedor.
  • nenhuma linha em todos os outros estados.
STATE_BOOKING_COMPLETE

O pedido contém:

  • uma ou mais linhas em "Reservado" ou "Recusado" pelos estados do vendedor.
  • nenhuma linha em todos os outros estados.
STATE_CANCELLED_BY_BUYER

O pedido contém:

  • uma ou mais linhas canceladas pelo comprador ou rejeitadas pelos estados do vendedor.
  • nenhuma linha em todos os outros estados.
STATE_PENDING_RESERVATION_EXPIRED

O pedido contém:

  • uma ou mais linhas na reserva pendente expiraram.
  • nenhuma linha em todos os outros estados.
STATE_RESERVED_EXPIRED

O pedido contém:

  • uma ou mais linhas em reservado expiraram.
  • nenhuma linha em todos os outros estados.

CancellationReason

O motivo do cancelamento, caso o pedido tenha sido cancelado.

Enums
CANCELLATION_REASON_UNSPECIFIED É o valor padrão quando o motivo do cancelamento não foi especificado ou é desconhecido nessa versão.
CANCELLATION_REASON_BUYER_REQUESTED O comprador solicitou o cancelamento do pedido.
CANCELLATION_REASON_INVALID_ADVERTISER_INFO As informações do anunciante fornecidas eram inválidas.

Métodos

completeOrderBooking

 Conclui a reserva do pedido.

completeOrderReservation

 Completa a reserva do pedido.

create

 Cria um novo pedido.

get

 Recupera um pedido individual.

list

 Lista os pedidos.

patch

 Atualiza um pedido existente.