AVB LINQ Public API

<back to all web services

SalesOrderShipmentCreateRequest

Magento Sales
The following routes are available for this service:
PUT/salesOrderShipmentAllows you to create a new shipment for an order.
SalesOrderShipmentCreateRequest Parameters:
NameParameterData TypeRequiredDescription
OrderIncrementIdbodystringYesOrder increment ID
ItemsQtybodyList<OrderItemIdQty>NoArray of orderItemIdQty
CommentbodystringNoShipment comment
EmailbodyintNoSend email flag. Default (0)
IncludeCommentbodyintNoInclude comment in email flag. Default (0)
OrderItemIdQty Parameters:
NameParameterData TypeRequiredDescription
OrderItemIdformintNoOrder item ID
QtyformdoubleNoQuantity
SalesOrderShipmentCreateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ShipmentIncrementIdformstringNo

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.

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

{
	orderIncrementId: String,
	itemsQty: 
	[
		{
			orderItemId: 0,
			qty: 0
		}
	],
	comment: String,
	email: 0,
	includeComment: 0
}
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
		}
	},
	shipmentIncrementId: String
}