GoogleApi.Content.V21.Model.OrdersUpdateShipmentRequest (google_api_content v0.49.0) View Source

Attributes

carrier (type: String.t, default: nil) - The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values.
deliveryDate (type: String.t, default: nil) - Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered.
lastPickupDate (type: String.t, default: nil) - Date after which the pickup will expire, in ISO 8601 format. Required only when order is buy-online-pickup-in-store(BOPIS) and status is ready for pickup.
operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
readyPickupDate (type: String.t, default: nil) - Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if status is ready for pickup.
scheduledDeliveryDetails (type: GoogleApi.Content.V21.Model.OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails.t, default: nil) - Delivery details of the shipment if scheduling is needed.
shipmentId (type: String.t, default: nil) - The ID of the shipment.
status (type: String.t, default: nil) - New status for the shipment. Not updated if missing. Acceptable values are: - "delivered" - "undeliverable" - "readyForPickup"
trackingId (type: String.t, default: nil) - The tracking ID for the shipment. Not updated if missing.
undeliveredDate (type: String.t, default: nil) - Date on which the shipment has been undeliverable, in ISO 8601 format. Optional and can be provided only if status is undeliverable.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

Specs

t() :: %GoogleApi.Content.V21.Model.OrdersUpdateShipmentRequest{
  carrier: String.t(),
  deliveryDate: String.t(),
  lastPickupDate: String.t(),
  operationId: String.t(),
  readyPickupDate: String.t(),
  scheduledDeliveryDetails:
    GoogleApi.Content.V21.Model.OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails.t(),
  shipmentId: String.t(),
  status: String.t(),
  trackingId: String.t(),
  undeliveredDate: String.t()
}

Link to this section Functions

decode(value, options)

Specs

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

Unwrap a decoded JSON object into its complex fields.