com.mozu.api.contracts.shippingruntime.RateRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mozu-api-core Show documentation
Show all versions of mozu-api-core Show documentation
Mozu Java is a SDK that enables you to create robust Java applications that integrate with the Mozu platform
/**
* This code was auto-generated by a Codezu.
*
* Changes to this file may cause incorrect behavior and will be lost if
* the code is regenerated.
*/
package com.mozu.api.contracts.shippingruntime;
import java.util.List;
import java.util.HashMap;
import java.io.Serializable;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import org.joda.time.DateTime;
import java.io.IOException;
import java.lang.ClassNotFoundException;
import com.mozu.api.contracts.shippingruntime.RateRequestAttribute;
import com.mozu.api.contracts.shippingruntime.CustomAttribute;
import com.mozu.api.contracts.core.Address;
import com.mozu.api.contracts.shippingruntime.RateRequestItem;
/**
* Properties required to request a shipping rate calculation.
*/
@JsonIgnoreProperties(ignoreUnknown = true)
public class RateRequest implements Serializable
{
// Default Serial Version UID
private static final long serialVersionUID = 1L;
/**
* List of shipping carriers for which to retrieve shipping rate information.
*/
protected List carrierIds;
public List getCarrierIds() {
return this.carrierIds;
}
public void setCarrierIds(List carrierIds) {
this.carrierIds = carrierIds;
}
/**
* The estimated date and time the shipment will be shipped to the shopper. This calculation is based on product stock, availability, date of order entry, and location.
*/
protected DateTime estimatedShipmentDate;
public DateTime getEstimatedShipmentDate() {
return this.estimatedShipmentDate;
}
public void setEstimatedShipmentDate(DateTime estimatedShipmentDate) {
this.estimatedShipmentDate = estimatedShipmentDate;
}
/**
* The total fee for shipment handling.
*/
protected Double handlingTotal;
public Double getHandlingTotal() {
return this.handlingTotal;
}
public void setHandlingTotal(Double handlingTotal) {
this.handlingTotal = handlingTotal;
}
/**
* Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values:
*/
protected String id;
public String getId() {
return this.id;
}
public void setId(String id) {
this.id = id;
}
protected Boolean isDestinationAddressCommercial;
public Boolean getIsDestinationAddressCommercial() {
return this.isDestinationAddressCommercial;
}
public void setIsDestinationAddressCommercial(Boolean isDestinationAddressCommercial) {
this.isDestinationAddressCommercial = isDestinationAddressCommercial;
}
protected String isoCurrencyCode;
public String getIsoCurrencyCode() {
return this.isoCurrencyCode;
}
public void setIsoCurrencyCode(String isoCurrencyCode) {
this.isoCurrencyCode = isoCurrencyCode;
}
/**
* The sub total of the order including all applicable discounts.
*/
protected Double orderDiscountedSubTotal;
public Double getOrderDiscountedSubTotal() {
return this.orderDiscountedSubTotal;
}
public void setOrderDiscountedSubTotal(Double orderDiscountedSubTotal) {
this.orderDiscountedSubTotal = orderDiscountedSubTotal;
}
protected Double orderTotal;
public Double getOrderTotal() {
return this.orderTotal;
}
public void setOrderTotal(Double orderTotal) {
this.orderTotal = orderTotal;
}
/**
* The unique identifier of the order to which the shipping rate is related.You can use Arc.js in combination with this property to retrieve other properties of the related order.
*/
protected String relatedOrderId;
public String getRelatedOrderId() {
return this.relatedOrderId;
}
public void setRelatedOrderId(String relatedOrderId) {
this.relatedOrderId = relatedOrderId;
}
/**
* The order number that the customer sees on the storefront when they place the order.
*/
protected Integer relatedOrderNumber;
public Integer getRelatedOrderNumber() {
return this.relatedOrderNumber;
}
public void setRelatedOrderNumber(Integer relatedOrderNumber) {
this.relatedOrderNumber = relatedOrderNumber;
}
/**
* The shipping methods associated with this request.
*/
protected List shippingServiceTypes;
public List getShippingServiceTypes() {
return this.shippingServiceTypes;
}
public void setShippingServiceTypes(List shippingServiceTypes) {
this.shippingServiceTypes = shippingServiceTypes;
}
/**
* Collection of attributes that may be paged list or a list, depending on the usage per object and API type.
*/
protected List attributes;
public List getAttributes() {
return this.attributes;
}
public void setAttributes(List attributes) {
this.attributes = attributes;
}
/**
* Collection of carrier-specific key-value attribute pairs associated with a shipping carrier. These are required to retrieve a shipping rate request and are returned for the generated shipping label.
*/
protected List customAttributes;
public List getCustomAttributes() {
return this.customAttributes;
}
public void setCustomAttributes(List customAttributes) {
this.customAttributes = customAttributes;
}
/**
* Data included in the shipping rate information.
*/
protected transient com.fasterxml.jackson.databind.JsonNode data;
public com.fasterxml.jackson.databind.JsonNode getData() {
return this.data;
}
public void setData(com.fasterxml.jackson.databind.JsonNode data) {
this.data = data;
}
protected Address destinationAddress;
public Address getDestinationAddress() {
return this.destinationAddress;
}
public void setDestinationAddress(Address destinationAddress) {
this.destinationAddress = destinationAddress;
}
protected List items;
public List getItems() {
return this.items;
}
public void setItems(List items) {
this.items = items;
}
/**
* The physical address from which the order or shipment will ship.
*/
protected Address originAddress;
public Address getOriginAddress() {
return this.originAddress;
}
public void setOriginAddress(Address originAddress) {
this.originAddress = originAddress;
}
private void writeObject(java.io.ObjectOutputStream out) throws IOException {
out.defaultWriteObject();
if(data == null){
out.writeBoolean(false);
} else {
out.writeBoolean(true);
new com.fasterxml.jackson.databind.ObjectMapper().configure(com.fasterxml.jackson.core.JsonGenerator.Feature.AUTO_CLOSE_TARGET, false).writeValue(out, data);
}
}
private void readObject(java.io.ObjectInputStream in) throws IOException, ClassNotFoundException {
in.defaultReadObject();
if(in.readBoolean()){
this.data = new com.fasterxml.jackson.databind.ObjectMapper().configure(com.fasterxml.jackson.core.JsonParser.Feature.AUTO_CLOSE_SOURCE, false).readValue(in, com.fasterxml.jackson.databind.JsonNode.class);
}
}
}