Warning: API call is no longer maintained!
Description
Sets tracking ID on an invoice specified by InvoiceNr
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
InvoiceNR |
string |
1 |
INV0001 |
InvoiceNr of the invoice you are setting tracking ID for. The way this procedure is typically used, InvoiceNr may come in embellished with an optional suffix, like invoice INV000001 may be specified as INV000001-1 or INV000001-2 This procedure looks for the first existing invoice by removing the suffixes one by one. I.e. in case of the example above, it will first look for invoice with Nr. INV000001-1, if not found, then INV000001. If the number is not found at all, the "non existing" message is returne |
2 |
TrackingID |
string |
1 |
123;124;124; |
Tracking IDs for the invoice |
3 |
Overwrite |
boolean |
0 |
0 or 1 |
Delete existing tracking IDs for package and set the new ones |
4 |
ResetClientNotifiedFlag |
boolean |
0 |
0 or 1 |
Reset ClientNotified flag back to: "N" |
5 |
Separator |
string |
0 |
; |
Delimiter used for splitting Tracking IDs |
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:pixiInvoiceSetTrackingID>
<dem:InvoiceNR>INV0001</dem:InvoiceNR>
<dem:TrackingID>123;124;124;</dem:TrackingID>
<dem:Overwrite>0 or 1</dem:Overwrite>
<dem:ResetClientNotifiedFlag>0 or 1</dem:ResetClientNotifiedFlag>
<dem:Separator>;</dem:Separator>
</dem:pixiInvoiceSetTrackingID>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Return status
# |
Name |
Type |
Description |
1 |
ReturnMessage |
string |
Return message |
Additional Notes
This API call is deprecated, we recommend to use these two calls instead
- pixiGetInvoicePackage
- pixiUpdateInvoicePackage