AVB LINQ Public API

<back to all web services

SalesOrderInvoiceCreateRequest

Magento Sales
The following routes are available for this service:
PUT/salesOrderInvoiceAllows you to create a new invoice for an order.
SalesOrderInvoiceCreateRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIncrementIdbodystringYesOrder increment ID
ItemsQtybodyList<OrderItemIdQty>NoArray of orderItemIdQty (quantity of items to invoice)
CommentbodystringNoShipment comment
EmailbodystringNoSend invoice on email. Default (0)
IncludeCommentbodystringNoInclude comments in email. Default (0)
OrderItemIdQty Parameters:
NameParameterData TypeRequiredDescription
OrderItemIdformintNoOrder item ID
QtyformdoubleNoQuantity
SalesOrderInvoiceCreateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
InvoiceIdformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /salesOrderInvoice HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"invoiceIncrementId":"String","itemsQty":[{"orderItemId":0,"qty":0}],"comment":"String","email":"String","includeComment":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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