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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SalesOrderShipmentCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.API.MagentoDTO">
  <Comment>String</Comment>
  <Email>0</Email>
  <IncludeComment>0</IncludeComment>
  <ItemsQty>
    <OrderItemIdQty>
      <OrderItemId>0</OrderItemId>
      <Qty>0</Qty>
    </OrderItemIdQty>
  </ItemsQty>
  <OrderIncrementId>String</OrderIncrementId>
</SalesOrderShipmentCreateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SalesOrderShipmentCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.API.MagentoDTO">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ShipmentIncrementId>String</ShipmentIncrementId>
</SalesOrderShipmentCreateResponse>