pixi Developer & Integration Documentation

pixiUpdateInvoicePackage

Description

API call procedure which updates invoice package info. This API sends MQ event "PackageLabelSaved" which triggers printing of Shipping label.


Request Parameters

#

Name

Type

Required

Example

Description

1

PackageId

integer

1

123

Reference for InvoicePackage table

2

InvoiceKey

integer

0

123

Reference for Invoices table.

3

ShippingLabelUrl

string

0

abcdefg

Used for updating the shipping vendor label url.

4

TrackingId

string

0

abcdefg

Used for updating the tracking Id of the package.

5

ReturnLabelUrl

string

0

abcdefg

Used for updating the return label url.

6

ReturnTrackingId

string

0

abcdefg

Used for updating the return tracking Id of the package.

7

ExternalShipmentId

string

0

abcdefg

Used for updating the external shipment ID of the package.

8

MessageFromProvider

string

0

abcdefg

Allows to transmit a message from the provider, such as an error message when the label cannot be produced

9

MessageFromProviderDetail

string

0

abcdefg

Allows to transmit a message from the provider, such as an error message details when the label cannot be produced

10

ResetClientNotifiedFlag

boolean

0

0 or 1

Mark the order for re-export to shop with new tracking or return tracking 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:pixiUpdateInvoicePackage>
         <dem:PackageId>123</dem:PackageId>
         <dem:InvoiceKey>123</dem:InvoiceKey>
         <dem:ShippingLabelUrl>abcdefg</dem:ShippingLabelUrl>
         <dem:TrackingId>abcdefg</dem:TrackingId>
         <dem:ReturnLabelUrl>abcdefg</dem:ReturnLabelUrl>
         <dem:ReturnTrackingId>abcdefg</dem:ReturnTrackingId>
         <dem:ExternalShipmentId>abcdefg</dem:ExternalShipmentId>
         <dem:MessageFromProvider>abcdefg</dem:MessageFromProvider>
         <dem:MessageFromProviderDetail>abcdefg</dem:MessageFromProviderDetail>
         <dem:ResetClientNotifiedFlag>0 or 1</dem:ResetClientNotifiedFlag>
      </dem:pixiUpdateInvoicePackage>
   </soapenv:Body>
</soapenv:Envelope>


Response


Body 1:

#

Name

Type

Description

1

Response

string

Returns a message if the execution was successfull (200) or not (400,500)


Additional Notes