REST-Ressource: accounts.customers.orders

Ressource: Bestellung

Entität, die die Bestellung eines Resellers für einen Kunden darstellt.

JSON-Darstellung 

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

string

Ressourcenname der Bestellung. Namen von Bestellungen haben das Format accounts/{account_id}/customers/{customer_id}/orders/{orderId} und sind schreibgeschützt.

offer

string

Ressourcenname des Angebots, zu dem diese Bestellung erfolgt. Angebote haben das Format accounts/{account_id}/offers/{offer_id}.

orderState

enum(OrderState)

Aktueller Status der Bestellung. Schreibgeschützt.

orderStateReason

string

Erläuterung des Status der Bestellung.

orderItems[]

object(OrderItem)

Die Artikel in der aktuellen Bestellung.

entitlements[]

string

Ressourcennamen von Berechtigungen haben das Format accounts/{account_id}/customers/{customer_id}/entitlements/{id} und sind schreibgeschützt.

createTime

string (Timestamp format)

Schreibgeschützt. Der Zeitpunkt, zu dem die Bestellung erstellt wird.

Ein Zeitstempel im Format "RFC3339 UTC 'Zulu'" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Der Zeitpunkt, zu dem die Bestellung aktualisiert wird.

Ein Zeitstempel im Format "RFC3339 UTC 'Zulu'" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".

OrderState

OrderState gibt den aktuellen Status der Bestellung an.

Enums
ORDER_STATE_UNSPECIFIED Der Status ist nicht angegeben.
PENDING Die Abwicklung der Bestellung steht noch aus.
COMPLETED Die Bestellung wurde ausgeführt.
ERROR Die Bestellung ist fehlerhaft.

OrderItem

Stellt eine Position in der Bestellung dar.

JSON-Darstellung 

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

string

Der Ressourcenname eines einzelnen Artikels, auf den in einem Angebot verwiesen wird. Angebotsartikel haben das Format accounts/{account_id}/offers/{offer_id}/offerItems/{offer_item_id}.

commitmentSettings

object(CommitmentSettings)

Verpflichtungseinstellungen bei kostenpflichtigem Abo. Schreibgeschützt.

numUnits

number

Bestelleinheiten, falls zutreffend. Bei Platzangeboten ist dies beispielsweise die Anzahl der Plätze, bei lizenzbasierten Angeboten die Anzahl der Lizenzen.

maxUnits

number

Maximale Anzahl von Einheiten, die dieser Bestellung zugewiesen werden dürfen.

renewalSettings

object(RenewalSettings)

Verlängerungseinstellungen bei verlängerbaren Abos.

CommitmentSettings

Verpflichtungseinstellungen bei verpflichtungsbasierten Angeboten.

JSON-Darstellung 

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

string (Timestamp format)

Zeitstempel für den Start der Verpflichtung.

Ein Zeitstempel im Format "RFC3339 UTC 'Zulu'" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
endDate

string (Timestamp format)

Zeitstempel für das Ende der Verpflichtung.

Ein Zeitstempel im Format "RFC3339 UTC 'Zulu'" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".

RenewalSettings

Verlängerungseinstellungen bei verlängerbaren Angeboten.

JSON-Darstellung 

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

boolean

Wenn "false", wird das Abo zum Enddatum beendet.

resizeUnitCount

boolean

Wenn "true" und "enableRenewal = true", wird die Einheit (z. B. Plätze oder Lizenzen) zum Verlängerungsdatum auf die Anzahl der aktiven Einheiten gesetzt.

disableCommitment

boolean

Wenn "true", wird die Verlängerung des verpflichtungsbasierten Abos deaktiviert und das Abo auf "Flexibel" oder "Pay as you go" umgestellt.

Methoden

activate

 Aktiviert eine zuvor gesperrte Bestellung.

create

 Erstellt Order im Namen eines Kunden.

get

 Gibt eine angeforderte Order-Ressource zurück.

list

 Listet die Order-Ressourcen eines Kunden auf.

patch

 Aktualisiert einen bestehenden Kunden [Bestellung].

suspend

 Sperrt eine zuvor abgewickelte Bestellung.