Recurso REST: accounts.customers.orders

Recurso: Order

Entidade que representa um pedido feito por um revendedor para um cliente.

Representação JSON 

{
  "name": string,
  "offer": string,
  "orderState": enum(OrderState),
  "orderStateReason": string,
  "orderItems": [
    {
      object(OrderItem)
    }
  ],
  "entitlements": [
    string
  ],
  "createTime": string,
  "updateTime": string
}
Campos
name

string

O nome do recurso do pedido. Os nomes de pedidos têm o formato: accounts/{account_id}/customers/{customer_id}/orders/{orderId} Somente leitura.

offer

string

O nome do recurso da oferta em relação à qual esse pedido está sendo feito. A oferta tem o formato: accounts/{account_id}/offers/{offer_id}

orderState

enum(OrderState)

Estado atual do pedido. Somente leitura.

orderStateReason

string

Uma explicação do estado do pedido.

orderItems[]

object(OrderItem)

Os itens no pedido atual.

entitlements[]

string

Os nomes de recursos de direitos têm o seguinte formato: accounts/{account_id}/customers/{customer_id}/entitlements/{id} Somente leitura.

createTime

string (Timestamp format)

Somente leitura. A hora em que o pedido é criado.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339 é medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

A hora em que o pedido é atualizado.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339 é medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

OrderState

OrderState indica o status atual do pedido.

Enumerações
ORDER_STATE_UNSPECIFIED O estado não foi especificado.
PENDING A conclusão do pedido está pendente.
COMPLETED O pedido foi executado.
ERROR O pedido está em estado de erro.

OrderItem

Representa um item de linha no pedido.

Representação JSON 

{
  "offerItem": string,
  "commitmentSettings": {
    object(CommitmentSettings)
  },
  "numUnits": number,
  "maxUnits": number,
  "renewalSettings": {
    object(RenewalSettings)
  }
}
Campos
offerItem

string

O nome do recurso de um único item mencionado em uma oferta. Os itens da oferta têm o seguinte formato: accounts/{account_id}/offers/{offer_id}/offerItems/{offer_item_id}.

commitmentSettings

object(CommitmentSettings)

Configurações de confirmação no caso de um plano baseado em compromisso. Somente leitura.

numUnits

number

Unidades do pedido, se aplicável. Por exemplo, para ofertas baseadas em assentos, esse seria o número de assentos, e para ofertas baseadas em licença, esse seria o número de licenças.

maxUnits

number

Máximo de unidades permitidas para este pedido.

renewalSettings

object(RenewalSettings)

Configurações de renovação para planos renováveis.

CommitmentSettings

Configurações de compromisso para ofertas baseadas em compromisso.

Representação JSON 

{
  "startDate": string,
  "endDate": string
}
Campos
startDate

string (Timestamp format)

Carimbo de data/hora de início do compromisso.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339 é medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
endDate

string (Timestamp format)

Carimbo de data/hora de término do compromisso.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339 é medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

RenewalSettings

Configurações de renovação para ofertas renováveis.

Representação JSON 

{
  "enableRenewal": boolean,
  "resizeUnitCount": boolean,
  "disableCommitment": boolean
}
Campos
enableRenewal

boolean

Se for falso, o plano será concluído na data de término.

resizeUnitCount

boolean

Se for verdadeiro e enableRenewal = verdadeiro, a unidade (por exemplo, assentos ou licenças) será definida como o número de unidades ativas no momento da renovação.

disableCommitment

boolean

Se for verdadeiro, desativa o plano baseado em compromisso na renovação e alterna para o plano flexível ou de pagamento conforme o uso.

Métodos

activate

 Ativa um pedido suspenso anteriormente.

create

 Cria um Order em nome de um cliente.

get

 Retorna um recurso Order solicitado.

list

 Lista Orders que pertencem a um cliente.

patch

 Atualiza o cliente existente [Order].

suspend

 Suspende um pedido preenchido anteriormente.