pixi Developer & Integration Documentation

pixiGetInvoicePackage

Description

API call returns invoice packages based on provided filter parameters.


Request Parameters

# Name Type Required Example Description
1 InvoiceNumber string 0 abcdefg Filter: Invoice number
2 InvoiceId integer 0 123 Filter: Invoice Id
3 PackageId integer 0 123 Filter: Package Id

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:pixiGetInvoicePackage>
         <dem:InvoiceNumber>abcdefg</dem:InvoiceNumber>
         <dem:InvoiceId>123</dem:InvoiceId>
         <dem:PackageId>123</dem:PackageId>
      </dem:pixiGetInvoicePackage>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Returned packages

# Name Type Description
1 PackageId integer Package Id
2 InvoiceId integer Invoice Id
3 GrossWeight number Weight of package
4 ShippingLabelUrl string Shipping label URL
5 TrackingId string Tracking ID of the shipment. Applies to the orders that have been shipped
6 TimesLabelPrinted string Counter how many times label was printed
7 ReturnLabelUrl string Return label URL
8 ReturnTrackingId string Return tracking Id
9 PackageDimensionId integer Package dimentions Id
10 ExternalShipmentId string External shipment Id
11 MessageFromProvider string Message from label provider
12 MessageFromProviderDetail string Detailed message from label provider
13 OrderNrExternal string External order number
14 InvoiceNr string pixi Invoice Number
15 PackageDimensionCode string Package dimension code

Body 2: Status output

# Name Type Description
1 Status string Execution status (Info/Error)
2 Message string Description of the status

Additional Notes