Description

API Call to ship out an invoice programmatically

Request Parameters

#	Name	Type	Required	Example	Description
1	InvoiceNr	string	0	abcdefg	pixi InvoiceNr to ship out (mandatory if BoxNr is not provided)
2	UserName	string	0	abcdefg	User which has shipped out that invoice
3	LocID	string	0	abc	Location ID of the invoice being shipped out
4	BoxNr	integer	0	123	Box number of order due for ship out (mandatory if InvoiceNr is not provided)
5	Weight	string	0	1.5	Total weight of the invoice
6	AmountOfPackages	integer	0	123	Amount of packages for the invoice
7	ShipVendorCode	string	0	abcdefg	Shipping vendor code
8	TrackingID	string	0	1234;1235;1236	Tracking ID(s) for the invoice

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiShipoutInvoice>
         <dem:InvoiceNr>abcdefg</dem:InvoiceNr>
         <dem:UserName>abcdefg</dem:UserName>
         <dem:LocID>abc</dem:LocID>
         <dem:BoxNr>123</dem:BoxNr>
         <dem:Weight>1.5</dem:Weight>
         <dem:AmountOfPackages>123</dem:AmountOfPackages>
         <dem:ShipVendorCode>abcdefg</dem:ShipVendorCode>
         <dem:TrackingID>1234;1235;1236</dem:TrackingID>
      </dem:pixiShipoutInvoice>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: Status output

#	Name	Type	Description
1	Status	string	Execution status (OK/ERROR)
2	StatusMessage	string	Description of the status

Additional Notes

The API call can only be used when **"Centralized Ship-Out"** or **"Premium API"** setting are **enabled**.