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

Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)

Attributes

  • acknowledged (type: boolean(), default: nil) - Whether the order was acknowledged.

  • channelType (type: String.t, default: nil) - Deprecated.

    Acceptable values are:

    • "googleExpress"
    • "purchasesOnGoogle"
  • customer (type: GoogleApi.Content.V2.Model.OrderCustomer.t, default: nil) - The details of the customer who placed the order.

  • deliveryDetails (type: GoogleApi.Content.V2.Model.OrderDeliveryDetails.t, default: nil) - Delivery details for shipments of type delivery.

  • id (type: String.t, default: nil) - The REST ID of the order. Globally unique.

  • kind (type: String.t, default: content#order) - Identifies what kind of resource this is. Value: the fixed string "content#order"

  • lineItems (type: list(GoogleApi.Content.V2.Model.OrderLineItem.t), default: nil) - Line items that are ordered.

  • merchantId (type: String.t, default: nil) -

  • merchantOrderId (type: String.t, default: nil) - Merchant-provided ID of the order.

  • netAmount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - 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.

  • paymentMethod (type: GoogleApi.Content.V2.Model.OrderPaymentMethod.t, default: nil) - The details of the payment method.

  • paymentStatus (type: String.t, default: nil) - The status of the payment.

    Acceptable values are:

    • "paymentCaptured"
    • "paymentRejected"
    • "paymentSecured"
    • "pendingAuthorization"
  • pickupDetails (type: GoogleApi.Content.V2.Model.OrderPickupDetails.t, default: nil) - Pickup details for shipments of type pickup.

  • placedDate (type: String.t, default: nil) - The date when the order was placed, in ISO 8601 format.

  • promotions (type: list(GoogleApi.Content.V2.Model.OrderLegacyPromotion.t), default: nil) - The details of the merchant provided promotions applied to the order.

    To determine which promotions apply to which products, check the Promotions[].Benefits[].OfferIds field against the LineItems[].Product.OfferId field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId.

    Examples:

    • To calculate the line item level discount for a single specific item: For each promotion, subtract the Promotions[].Benefits[].Discount.value amount from the LineItems[].Price.value.
    • To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the Promotions[].Benefits[].Discount.value by the quantity of products and substract it from LineItems[].Product.Price.value for each quantity item.

    Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price.

    More details about the program are here.

  • refunds (type: list(GoogleApi.Content.V2.Model.OrderRefund.t), default: nil) - Refunds for the order.

  • shipments (type: list(GoogleApi.Content.V2.Model.OrderShipment.t), default: nil) - Shipments of the order.

  • shippingCost (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The total cost of shipping for all items.

  • shippingCostTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The tax for the total shipping cost.

  • shippingOption (type: String.t, default: nil) - Deprecated. Shipping details are provided with line items instead.

    Acceptable values are:

    • "economy"
    • "expedited"
    • "oneDay"
    • "sameDay"
    • "standard"
    • "twoDay"
  • status (type: String.t, default: nil) - The status of the order.

    Acceptable values are:

    • "canceled"
    • "delivered"
    • "inProgress"
    • "partiallyDelivered"
    • "partiallyReturned"
    • "partiallyShipped"
    • "pendingShipment"
    • "returned"
    • "shipped"
  • taxCollector (type: String.t, default: nil) - The party responsible for collecting and remitting taxes.

    Acceptable values are:

    • "marketplaceFacilitator"
    • "merchant"

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: boolean(),
  channelType: String.t(),
  customer: GoogleApi.Content.V2.Model.OrderCustomer.t(),
  deliveryDetails: GoogleApi.Content.V2.Model.OrderDeliveryDetails.t(),
  id: String.t(),
  kind: String.t(),
  lineItems: [GoogleApi.Content.V2.Model.OrderLineItem.t()],
  merchantId: String.t(),
  merchantOrderId: String.t(),
  netAmount: GoogleApi.Content.V2.Model.Price.t(),
  paymentMethod: GoogleApi.Content.V2.Model.OrderPaymentMethod.t(),
  paymentStatus: String.t(),
  pickupDetails: GoogleApi.Content.V2.Model.OrderPickupDetails.t(),
  placedDate: String.t(),
  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: String.t(),
  status: String.t(),
  taxCollector: String.t()
}

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.