AVB LINQ Public API

SalesOrderShipmentCreateRequest

Magento Sales

The following routes are available for this service:
PUT	/salesOrderShipment	Allows you to create a new shipment for an order.

**SalesOrderShipmentCreateRequest** Parameters:
Name	Parameter	Data Type	Required	Description
OrderIncrementId	body	string	Yes	Order increment ID
ItemsQty	body	List<OrderItemIdQty>	No	Array of orderItemIdQty
Comment	body	string	No	Shipment comment
Email	body	int	No	Send email flag. Default (0)
IncludeComment	body	int	No	Include comment in email flag. Default (0)

**OrderItemIdQty** Parameters:
Name	Parameter	Data Type	Required	Description
OrderItemId	form	int	No	Order item ID
Qty	form	double	No	Quantity

**SalesOrderShipmentCreateResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
ShipmentIncrementId	form	string	No

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

HTTP + CSV

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

PUT /salesOrderShipment HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"orderIncrementId":"String","itemsQty":[{"orderItemId":0,"qty":0}],"comment":"String","email":0,"includeComment":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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