GoogleApi.Content.V21.Model.OrderTrackingSignal (google_api_content v0.58.1) View Source

Represents a merchant trade from which signals are extracted, e.g. shipping.

Attributes

  • customerShippingFee (type: GoogleApi.Content.V21.Model.PriceAmount.t, default: nil) - The shipping fee of the order; this value should be set to zero in the case of free shipping.
  • deliveryPostalCode (type: String.t, default: nil) - Required. The delivery postal code, as a continuous string without spaces or dashes, e.g. "95016".
  • deliveryRegionCode (type: String.t, default: nil) - Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination.
  • lineItems (type: list(GoogleApi.Content.V21.Model.OrderTrackingSignalLineItemDetails.t), default: nil) - Information about line items in the order.
  • merchantId (type: String.t, default: nil) - The Google merchant ID of this order tracking signal. This value is optional. If left unset, the caller's merchant ID is used. You must request access in order to provide data on behalf of another merchant. For more information, see Submitting Order Tracking Signals.
  • orderCreatedTime (type: GoogleApi.Content.V21.Model.DateTime.t, default: nil) - Required. The time when the order was created on the merchant side. Include the year and timezone string, if available.
  • orderId (type: String.t, default: nil) - Required. The ID of the order on the merchant side.
  • orderTrackingSignalId (type: String.t, default: nil) - Output only. The ID that uniquely identifies this order tracking signal.
  • shipmentLineItemMapping (type: list(GoogleApi.Content.V21.Model.OrderTrackingSignalShipmentLineItemMapping.t), default: nil) - The mapping of the line items to the shipment information.
  • shippingInfo (type: list(GoogleApi.Content.V21.Model.OrderTrackingSignalShippingInfo.t), default: nil) - The shipping information for the order.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Content.V21.Model.OrderTrackingSignal{
  customerShippingFee: GoogleApi.Content.V21.Model.PriceAmount.t() | nil,
  deliveryPostalCode: String.t() | nil,
  deliveryRegionCode: String.t() | nil,
  lineItems:
    [GoogleApi.Content.V21.Model.OrderTrackingSignalLineItemDetails.t()] | nil,
  merchantId: String.t() | nil,
  orderCreatedTime: GoogleApi.Content.V21.Model.DateTime.t() | nil,
  orderId: String.t() | nil,
  orderTrackingSignalId: String.t() | nil,
  shipmentLineItemMapping:
    [GoogleApi.Content.V21.Model.OrderTrackingSignalShipmentLineItemMapping.t()]
    | nil,
  shippingInfo:
    [GoogleApi.Content.V21.Model.OrderTrackingSignalShippingInfo.t()] | nil
}

Link to this section Functions

Specs

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

Unwrap a decoded JSON object into its complex fields.