GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryCancelLineItem (google_api_content v0.58.1) View Source

Attributes

  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Deprecated. Please use amountPretax and amountTax instead.
  • amountPretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
  • amountTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.
  • lineItemId (type: String.t, default: nil) - The ID of the line item to cancel. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to cancel.
  • reason (type: String.t, default: nil) - The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryCancelLineItem{
  amount: GoogleApi.Content.V2.Model.Price.t() | nil,
  amountPretax: GoogleApi.Content.V2.Model.Price.t() | nil,
  amountTax: GoogleApi.Content.V2.Model.Price.t() | nil,
  lineItemId: String.t() | nil,
  productId: String.t() | nil,
  quantity: integer() | nil,
  reason: String.t() | nil,
  reasonText: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.