Order

Entity representing an order placed by a reseller for a customer.

JSON representation 
{
  "name": string,
  "offerId": string,
  "orderStatus": enum(OrderStatus),
  "purchaseOrderId": string,
  "orderItems": [
    {
      object(OrderItem)
    }
  ],
  "entitlementName": [
    string
  ],
  "createTime": string,
  "updateTime": string
}
Fields
name

string

The resource name of the order. Order names have the form: accounts/{account_id}/customers/{customer_id}/orders/{orderId} Read only.

offerId

string

The resource name of the offer against which this order is being placed. Offer ids have the form: accounts/{account_id}/offers/{offerId}

orderStatus

enum(OrderStatus)

Current status of the order. Read only.

purchaseOrderId

string

Purchase order id allowing resellers for tracking on their side.

orderItems[]

object(OrderItem)
entitlementName[]

string

Entitlements created after an order is fulfilled. Entitlement resource names are of the form: accounts/{account_id}/customers/{customer_id}/entitlements/{id} Read-only.

createTime

string (Timestamp format)

Read-only.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

OrderItem

JSON representation 
{
  "offerItemName": string,
  "commitmentSettings": {
    object(CommitmentSettings)
  },
  "renewalType": enum(RenewalType),
  "numUnits": number,
  "maxUnits": number,
  "paymentPlan": enum(PaymentPlan)
}
Fields
offerItemName

string

The resource name of a single item referenced in an offer. Offer item names are of the form: accounts/{account_id}/offers/{offerId}/offerItems/{offer_item_id}.

commitmentSettings

object(CommitmentSettings)

Commitment settings if commitment based plan. Read Only.

renewalType

enum(RenewalType)

Renewal settings for renewable plans.

numUnits

number

Order units if applicable. For example, for seat-based offers, this would be number of seats; for license based offers, this would be number of licenses;

maxUnits

number
paymentPlan

enum(PaymentPlan)

Payment plan associated with the order.