POST | /orders/{OrderNumber}/shipments |
---|
export class NAVOrderShipmentCreateResponse
{
public responseStatus?: ResponseStatus;
public constructor(init?: Partial<NAVOrderShipmentCreateResponse>) { (Object as any).assign(this, init); }
}
export class NAVOrderShipmentSku
{
public orderLineNumber?: number;
public quantityShipped?: number;
public substituteSkuCode?: string;
public constructor(init?: Partial<NAVOrderShipmentSku>) { (Object as any).assign(this, init); }
}
export class NAVOrderShipment
{
public shippingMethod?: string;
public shippingSpeed?: string;
public trackingNumber?: string;
public shipmentStatus?: string;
public shipmentDetails?: string;
public shippingCost?: number;
public charge?: number;
public tax?: number;
public actualShippingCost?: number;
public cartonWeight?: number;
public orderShipmentSku?: NAVOrderShipmentSku[];
public constructor(init?: Partial<NAVOrderShipment>) { (Object as any).assign(this, init); }
}
export class NAVOrderShipmentCreate implements IPost
{
public orderNumber?: string;
public shipmentDateUTC?: string;
public shipment?: NAVOrderShipment[];
public constructor(init?: Partial<NAVOrderShipmentCreate>) { (Object as any).assign(this, init); }
}
TypeScript NAVOrderShipmentCreate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } } }