GoogleApi.Content.V21.Model.Order (google_api_content v0.49.0) View Source
Order. Production access (all methods) requires the order manager role. Sandbox access does not.
Attributes
-
acknowledged(type:boolean(), default:nil) - Whether the order was acknowledged. -
annotations(type:list(GoogleApi.Content.V21.Model.OrderOrderAnnotation.t), default:nil) - List of key-value pairs that are attached to a given order. -
billingAddress(type:GoogleApi.Content.V21.Model.OrderAddress.t, default:nil) - The billing address. -
customer(type:GoogleApi.Content.V21.Model.OrderCustomer.t, default:nil) - The details of the customer who placed the order. -
deliveryDetails(type:GoogleApi.Content.V21.Model.OrderDeliveryDetails.t, default:nil) - Delivery details for shipments of typedelivery. -
id(type:String.t, default:nil) - The REST ID of the order. Globally unique. -
kind(type:String.t, default:nil) - Identifies what kind of resource this is. Value: the fixed string "content#order" -
lineItems(type:list(GoogleApi.Content.V21.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. -
netPriceAmount(type:GoogleApi.Content.V21.Model.Price.t, default:nil) - The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80. -
netTaxAmount(type:GoogleApi.Content.V21.Model.Price.t, default:nil) - The net amount for the order (tax part). Note that in certain cases due to taxable base adjustmentnetTaxAmountmight not match to a sum of tax field across all lineItems and refunds. -
paymentStatus(type:String.t, default:nil) - The status of the payment. Acceptable values are: - "paymentCaptured" - "paymentRejected" - "paymentSecured" - "pendingAuthorization" -
pickupDetails(type:GoogleApi.Content.V21.Model.OrderPickupDetails.t, default:nil) - Pickup details for shipments of typepickup. -
placedDate(type:String.t, default:nil) - The date when the order was placed, in ISO 8601 format. -
promotions(type:list(GoogleApi.Content.V21.Model.OrderPromotion.t), default:nil) - Promotions associated with the order. To determine which promotions apply to which products, check thePromotions[].appliedItems[].lineItemIdfield against theLineItems[].idfield 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: 1. To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract theLineItems[].adjustments[].priceAdjustment.valueamount from theLineItems[].Price.value. 2. To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide theLineItems[].adjustments[].priceAdjustment.valueby the quantity of products then subtract the resulting value from theLineItems[].Product.Price.valuefor 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.V21.Model.OrderRefund.t), default:nil) - Refunds for the order. -
shipments(type:list(GoogleApi.Content.V21.Model.OrderShipment.t), default:nil) - Shipments of the order. -
shippingCost(type:GoogleApi.Content.V21.Model.Price.t, default:nil) - The total cost of shipping for all items. -
shippingCostTax(type:GoogleApi.Content.V21.Model.Price.t, default:nil) - The tax for the total shipping cost. -
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
Specs
t() :: %GoogleApi.Content.V21.Model.Order{
acknowledged: boolean(),
annotations: [GoogleApi.Content.V21.Model.OrderOrderAnnotation.t()],
billingAddress: GoogleApi.Content.V21.Model.OrderAddress.t(),
customer: GoogleApi.Content.V21.Model.OrderCustomer.t(),
deliveryDetails: GoogleApi.Content.V21.Model.OrderDeliveryDetails.t(),
id: String.t(),
kind: String.t(),
lineItems: [GoogleApi.Content.V21.Model.OrderLineItem.t()],
merchantId: String.t(),
merchantOrderId: String.t(),
netPriceAmount: GoogleApi.Content.V21.Model.Price.t(),
netTaxAmount: GoogleApi.Content.V21.Model.Price.t(),
paymentStatus: String.t(),
pickupDetails: GoogleApi.Content.V21.Model.OrderPickupDetails.t(),
placedDate: String.t(),
promotions: [GoogleApi.Content.V21.Model.OrderPromotion.t()],
refunds: [GoogleApi.Content.V21.Model.OrderRefund.t()],
shipments: [GoogleApi.Content.V21.Model.OrderShipment.t()],
shippingCost: GoogleApi.Content.V21.Model.Price.t(),
shippingCostTax: GoogleApi.Content.V21.Model.Price.t(),
status: String.t(),
taxCollector: String.t()
}
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.