NAV

<back to all web services

NAVOrderShipmentCreate

The following routes are available for this service:
POST/orders/{OrderNumber}/shipments
namespace NAV.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type NAVOrderShipmentCreateResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type NAVOrderShipmentSku() = 
        member val OrderLineNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val QuantityShipped:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SubstituteSkuCode:String = null with get,set

    [<AllowNullLiteral>]
    type NAVOrderShipment() = 
        member val ShippingMethod:String = null with get,set
        member val ShippingSpeed:String = null with get,set
        member val TrackingNumber:String = null with get,set
        member val ShipmentStatus:String = null with get,set
        member val ShipmentDetails:String = null with get,set
        member val ShippingCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Charge:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Tax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ActualShippingCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CartonWeight:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OrderShipmentSku:ResizeArray<NAVOrderShipmentSku> = new ResizeArray<NAVOrderShipmentSku>() with get,set

    [<AllowNullLiteral>]
    type NAVOrderShipmentCreate() = 
        interface IPost
        member val OrderNumber:String = null with get,set
        member val ShipmentDateUTC:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Shipment:ResizeArray<NAVOrderShipment> = new ResizeArray<NAVOrderShipment>() with get,set

F# 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
		}
	}
}