NAV

<back to all web services

NAVOrderShipmentCreate

The following routes are available for this service:
POST/orders/{OrderNumber}/shipments
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class NAVOrderShipmentCreate implements IPost
    {
        public String orderNumber = null;
        public Date shipmentDateUTC = null;
        public ArrayList<NAVOrderShipment> shipment = null;
        
        public String getOrderNumber() { return orderNumber; }
        public NAVOrderShipmentCreate setOrderNumber(String value) { this.orderNumber = value; return this; }
        public Date getShipmentDateUTC() { return shipmentDateUTC; }
        public NAVOrderShipmentCreate setShipmentDateUTC(Date value) { this.shipmentDateUTC = value; return this; }
        public ArrayList<NAVOrderShipment> getShipment() { return shipment; }
        public NAVOrderShipmentCreate setShipment(ArrayList<NAVOrderShipment> value) { this.shipment = value; return this; }
    }

    public static class NAVOrderShipment
    {
        public String shippingMethod = null;
        public String shippingSpeed = null;
        public String trackingNumber = null;
        public String shipmentStatus = null;
        public String shipmentDetails = null;
        public BigDecimal shippingCost = null;
        public BigDecimal charge = null;
        public BigDecimal tax = null;
        public BigDecimal actualShippingCost = null;
        public BigDecimal cartonWeight = null;
        public ArrayList<NAVOrderShipmentSku> orderShipmentSku = null;
        
        public String getShippingMethod() { return shippingMethod; }
        public NAVOrderShipment setShippingMethod(String value) { this.shippingMethod = value; return this; }
        public String getShippingSpeed() { return shippingSpeed; }
        public NAVOrderShipment setShippingSpeed(String value) { this.shippingSpeed = value; return this; }
        public String getTrackingNumber() { return trackingNumber; }
        public NAVOrderShipment setTrackingNumber(String value) { this.trackingNumber = value; return this; }
        public String getShipmentStatus() { return shipmentStatus; }
        public NAVOrderShipment setShipmentStatus(String value) { this.shipmentStatus = value; return this; }
        public String getShipmentDetails() { return shipmentDetails; }
        public NAVOrderShipment setShipmentDetails(String value) { this.shipmentDetails = value; return this; }
        public BigDecimal getShippingCost() { return shippingCost; }
        public NAVOrderShipment setShippingCost(BigDecimal value) { this.shippingCost = value; return this; }
        public BigDecimal getCharge() { return charge; }
        public NAVOrderShipment setCharge(BigDecimal value) { this.charge = value; return this; }
        public BigDecimal getTax() { return tax; }
        public NAVOrderShipment setTax(BigDecimal value) { this.tax = value; return this; }
        public BigDecimal getActualShippingCost() { return actualShippingCost; }
        public NAVOrderShipment setActualShippingCost(BigDecimal value) { this.actualShippingCost = value; return this; }
        public BigDecimal getCartonWeight() { return cartonWeight; }
        public NAVOrderShipment setCartonWeight(BigDecimal value) { this.cartonWeight = value; return this; }
        public ArrayList<NAVOrderShipmentSku> getOrderShipmentSku() { return orderShipmentSku; }
        public NAVOrderShipment setOrderShipmentSku(ArrayList<NAVOrderShipmentSku> value) { this.orderShipmentSku = value; return this; }
    }

    public static class NAVOrderShipmentSku
    {
        public Integer orderLineNumber = null;
        public Integer quantityShipped = null;
        public String substituteSkuCode = null;
        
        public Integer getOrderLineNumber() { return orderLineNumber; }
        public NAVOrderShipmentSku setOrderLineNumber(Integer value) { this.orderLineNumber = value; return this; }
        public Integer getQuantityShipped() { return quantityShipped; }
        public NAVOrderShipmentSku setQuantityShipped(Integer value) { this.quantityShipped = value; return this; }
        public String getSubstituteSkuCode() { return substituteSkuCode; }
        public NAVOrderShipmentSku setSubstituteSkuCode(String value) { this.substituteSkuCode = value; return this; }
    }

    public static class NAVOrderShipmentCreateResponse
    {
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public NAVOrderShipmentCreateResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java NAVOrderShipmentCreate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /orders/{OrderNumber}/shipments HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	orderNumber: String,
	shipmentDateUTC: 0001-01-01T00:00:00,
	shipment: 
	[
		{
			shippingMethod: String,
			shippingSpeed: String,
			trackingNumber: String,
			shipmentStatus: String,
			shipmentDetails: String,
			shippingCost: 0,
			charge: 0,
			tax: 0,
			actualShippingCost: 0,
			cartonWeight: 0,
			orderShipmentSku: 
			[
				{
					orderLineNumber: 0,
					quantityShipped: 0,
					substituteSkuCode: String
				}
			]
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}