google_api_content v0.4.0 GoogleApi.Content.V2.Model.Order View Source

Order. All methods require the order manager role.

Attributes

  • acknowledged (boolean()): Whether the order was acknowledged. Defaults to: null.
  • channelType (String.t): The channel type of the order: "purchaseOnGoogle" or "googleExpress". Defaults to: null.
  • customer (OrderCustomer): The details of the customer who placed the order. Defaults to: null.
  • deliveryDetails (OrderDeliveryDetails): The details for the delivery. Defaults to: null.
  • id (String.t): The REST id of the order. Globally unique. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#order". Defaults to: null.
  • lineItems ([OrderLineItem]): Line items that are ordered. Defaults to: null.
  • merchantId (String.t): Defaults to: null.
  • merchantOrderId (String.t): Merchant-provided id of the order. Defaults to: null.
  • netAmount (Price): The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80. Defaults to: null.
  • paymentMethod (OrderPaymentMethod): The details of the payment method. Defaults to: null.
  • paymentStatus (String.t): The status of the payment. Defaults to: null.
  • placedDate (String.t): The date when the order was placed, in ISO 8601 format. Defaults to: null.
  • promotions ([OrderLegacyPromotion]): Deprecated. Ignored if provided for createTestOrder. The details of the merchant provided promotions applied to the order. More details about the program are here. Defaults to: null.
  • refunds ([OrderRefund]): Refunds for the order. Defaults to: null.
  • shipments ([OrderShipment]): Shipments of the order. Defaults to: null.
  • shippingCost (Price): The total cost of shipping for all items. Defaults to: null.
  • shippingCostTax (Price): The tax for the total shipping cost. Defaults to: null.
  • shippingOption (String.t): The requested shipping option. Defaults to: null.
  • status (String.t): The status of the order. Defaults to: null.
  • taxCollector (String.t): The party responsible for collecting and remitting taxes. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Content.V2.Model.Order{
  acknowledged: any(),
  channelType: any(),
  customer: GoogleApi.Content.V2.Model.OrderCustomer.t(),
  deliveryDetails: GoogleApi.Content.V2.Model.OrderDeliveryDetails.t(),
  id: any(),
  kind: any(),
  lineItems: [GoogleApi.Content.V2.Model.OrderLineItem.t()],
  merchantId: any(),
  merchantOrderId: any(),
  netAmount: GoogleApi.Content.V2.Model.Price.t(),
  paymentMethod: GoogleApi.Content.V2.Model.OrderPaymentMethod.t(),
  paymentStatus: any(),
  placedDate: any(),
  promotions: [GoogleApi.Content.V2.Model.OrderLegacyPromotion.t()],
  refunds: [GoogleApi.Content.V2.Model.OrderRefund.t()],
  shipments: [GoogleApi.Content.V2.Model.OrderShipment.t()],
  shippingCost: GoogleApi.Content.V2.Model.Price.t(),
  shippingCostTax: GoogleApi.Content.V2.Model.Price.t(),
  shippingOption: any(),
  status: any(),
  taxCollector: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.