| POST | /orders/{OrderNumber}/shipments |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderNumber | path | string | No | |
| ShipmentDateUTC | body | DateTime? | No | |
| Shipment | body | List<NAVOrderShipment> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShippingMethod | form | string | No | |
| ShippingSpeed | form | string | No | |
| TrackingNumber | form | string | No | |
| ShipmentStatus | form | string | No | |
| ShipmentDetails | form | string | No | |
| ShippingCost | form | decimal? | No | |
| Charge | form | decimal? | No | |
| Tax | form | decimal? | No | |
| ActualShippingCost | form | decimal? | No | |
| CartonWeight | form | decimal? | No | |
| OrderShipmentSku | form | List<NAVOrderShipmentSku> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderLineNumber | form | int? | No | |
| QuantityShipped | form | int? | No | |
| SubstituteSkuCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
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
}
}
}