ParcelOne provides you with a WCF API for implementing an interface to ParcelOne shipping services into your own shop or, respectively, into the shops of your customers.

Here you will find a complete documentation of the available API functions with descriptions of request methods, request parameters as well as request and response formats. If you would like to investigate code samples of client implementations in php or C#, you can find them under

• for php (requires php 5.2 or higher): https://sandboxapi.awiwe.solutions/version4/shippingwcfsandbox/doc/ShippingWCF_Client_Sandbox_Example_php.zip
• for C# (requires Visual Studio 10 or higher): https://sandboxapi.awiwe.solutions/version4/shippingwcfsandbox/doc/ShippingWCF_Client_Sandbox_Example_CSharp.zip

As a communication platform we use WCF (Windows Communication Foundation).

Authentification is provided by Basic Authentification secured over SSL. Further authentification is done via an API-Key to authenificate the provider of the client software accessing the API. Please, contact us if you would like to receive an API-Key and Sandbox Login data for your client development.

Operations

Remarks

In order to be able to test your code without interfering the production environment, we provide a SandBox-Mode as well as a Production-Mode. You can reach the Sandbox- or Test-Mode under …

• Service: https://sandboxapi.awiwe.solutions/version4/shippingwcfsandbox/ShippingWCF.svc
• WSDL: https://sandboxapi.awiwe.solutions/version4/shippingwcfsandbox/ShippingWCF.svc?wsdl

• Service: https://productionapi.awiwe.solutions/version4/shippingwcf/ShippingWCF.svc
• WSDL: https://productionapi.awiwe.solutions/version4/shippingwcf/ShippingWCF.svc?wsdl

IShippingWCF\closeShipments(ClosedStamp, Mandator, Consigner, CEP, Format, Shipments)

Close Forward Shipments. (only marked as closed and returning a report. For DHL it does NOT perform the actual DHL closing, this will be done automatically by IntraShip once a day. )

Parameters

Return

Remarks

You have several possibilities to influence the selection of shipments to be closed:

1. ClosedStamp: Provide the ClosedStamp to reprint a Closing Report. No unclosed shipments are touched. (See also function getClosedStamps.)
2. Mandator: Only unclosed shipments for this Mandator are closed.
3. Consigner: Only unclosed shipments for this Consigner are closed.
4. CEP: Only unclosed shipments for this Carrier are closed.
5. Format: Format contains information on how to return the data. Only Format.Type is needed, possible values are PDF or CSV.
6. Shipments: You can provide a list of Shipments. Only those in your list will be closed.

The parameters Mandator, Consigner and CEP can be mixed and will be considered in an AND-relation.

Example

Here is how you use this:

ClosedResult[] closeShipments(string ClosedStamp, string Mandator, string Consigner, string CEP, Format Format, identifyShipment[] Shipments);

Faults

• No exceptions, just the returned data may be empty.

IShippingWCF\getCEPs(Mandator, level, Countries)

Get available Carriers for a mandator, optionally filtered by countries list.

Parameters

Return

Remarks

Parameters:

1. Mandator: Mandator
2. level: 0 = all levels returned; 1 = only 1 level returned (only carriers), 2 = only 2 levels returned (carrier and products info), >=3 = also services per product returned
3. Countries: optional String array of Alpha-2-code Country abbreviations (ISO 3166-1) to be checked against available carriers and products. Only carriers and products are returned that are available for ALL countries specified. If empty or null, no Countries check is taking place.

Example

Here is how you use this:

CEP[] getCEPs(string Mandator, int level, String[] Countries);

Faults

• No exceptions, just the returned data may be empty.

IShippingWCF\getCharges(ChargesData)

Get Shipment Charges.

Parameters

Return

Remarks

Parameter:

1. ChargesData: You can provide a list of Shipments to get Shipment Charges info for them.

Return value: Array of ChargesResult containing ShipmentCharges, PackageCharges if available and Totalcharges as well as ShipmentActionResult containing ShipmentID, ShipmentRef and TrackingID for identification of shipments, Success flag (1=successfull, -1=not successfull), and Array of Errors (Errorno, Message and StatusCode) in case not being successfull

Example

Here is how you use this:

ChargesResult[] getCharges(Charges[] ChargesData);

Faults

• No exceptions, just the returned data may contain errors per shipment.

IShippingWCF\getClosableShipments(Mandator, Consigner, CEP)

get Closable Forward Shipments. May be filtered by Mandantor, Consigner and Carrier.

Parameters

Return

Remarks

You have several possibilities to influence the selection of shipments to be returned as closable:

1. Mandator: Only unclosed shipments for this Mandator are returned.
2. Consigner: Only unclosed shipments for this Consigner are returned.
3. CEP: Only unclosed shipments for this Carrier are returned.

The parameters Mandator, Consigner and CEP can be mixed and will be considered in an AND-relation.

Example

Here is how you use this:

printDocumentsResult[] getClosableShipments(string Mandator, string Consigner, string CEP);

Faults

• No exceptions, just the returned CSV data may be empty.

IShippingWCF\getClosedStamps(Mandator, Consigner, CEP, StartDate, EndDate)

get ClosedStamps to have a list of all finished closings. May be filtered by Mandantor, Consigner and Carrier as well as StartDate and EndDate.

Parameters

Return

Remarks

You have several possibilities to influence the selection of ClosedStamps to be returned:

1. Mandator: Only ClosedStamps for this Mandator are returned.
2. Consigner: Only ClosedStamps for this Consigner are returned.
3. CEP: Only ClosedStamps for this Carrier are returned.
4. StartDate: Only ClosedStamps equal or after this StartDate are returned.
5. EndDate: Only ClosedStamps equal or before this EndDate are returned.

All parameters can be mixed and will be considered in an AND-relation.

Example

Here is how you use this:

String[] getClosedStamps(string Mandator, string Consigner, string CEP, string StartDate, string EndDate);

Faults

• No exceptions, just the returned string array may be empty.

IShippingWCF\getCustomers()

Get the availabe Customer’s Information and status.

Return

Remarks

Return value: Array of Customer, containing CustomerID + MandatorID, Default flag, Shortname, StatusID and Status as well as Array of Consigners for this Mandator.

Possible statuses: ID 0 = Customer active, ID 1 = Customer blocked, ID 2 = Customer anulled

Example

Here is how you use this:

Customer[] getCustomers();

Faults

• No exceptions, just the returned data may be empty.

IShippingWCF\getDateTime()

Get Server DateTime to compare with Client DateTime.

Return

Example

Here is how you use this:

DateTime GetDateTime();

Faults

• No exceptions.

IShippingWCF\getProducts(Mandator, CEP, level, Countries)

Get available Products for a mandator and Carrier, optionally filtered by countries list.

Parameters

Return

Remarks

Parameters:

1. Mandator: Mandator
2. CEP: Carrier
3. level: 0 = all levels returned; 1 = only 1 level returned (only products), >=2 = 2 levels returned (products and services info)
4. Countries: optional String array of Alpha-2-code Country abbreviations (ISO 3166-1) to be checked against available carriers and products. Only carriers and products are returned that are available for ALL countries specified. If empty or null, no Countries check is taking place.

Example

Here is how you use this:

Product[] getProducts(string Mandator, string CEP, int level, String[] Countries);

Faults

• No exceptions, just the returned data may be empty.

IShippingWCF\getProfiles(level, Countries)

Get all available carriers for all Mandators, optionally filtered by countries list.

Parameters

Return

Remarks

Parameters:

1. level: 0 = all levels returned; 1 = only 1 level returned (only carriers), 2 = only 2 levels returned (carrier and products info), >=3 = also services per product returned
2. Countries: optional String array of Alpha-2-code Country abbreviations (ISO 3166-1) to be checked against available carriers and products. Only carriers and products are returned that are available for ALL countries specified. If empty or null, no Countries check is taking place.

Example

Here is how you use this:

Profile[] getProfiles(int level, String[] Countries);

Faults

• No exceptions, just the returned data may be empty.

IShippingWCF\getServices(Mandator, CEP, Product, Countries)

Get available Services for a mandator,Carrier,product, optionally filtered by countries list.

Parameters

Return

Remarks

Parameters:

1. Mandator: Mandator
2. CEP: Carrier
3. Product: Product
4. Countries: optional String array of Alpha-2-code Country abbreviations (ISO 3166-1) to be checked against available carriers and products. Only carriers and products are returned that are available for ALL countries specified. If empty or null, no Countries check is taking place.

Example

Here is how you use this:

Service[] getServices(string Mandator, string CEP, string Product, String[] Countries);

Faults

• No exceptions, just the returned data may be empty.

IShippingWCF\getShipmentStatus(ShippingData)

Get Shipment Status.

Parameters

Return

Remarks

Parameter:

1. ShippingData: You can provide a list of Shipments to get Shipment Status info for them.

Return value: Array of ShipmentStatusResult containing ShipmentStatusCode and ShipmentStatus, LastTrackingNo and LastCEP containing DestinationCarrier data as far as known as well as ShipmentActionResult containing ShipmentID, ShipmentRef and TrackingID for identification of shipments, Success flag (1=successfull, -1=not successfull), and Array of Errors (Errorno, Message and StatusCode) in case not being successfull

Possible returned status values so far: Code 10 = Shipped; Code 90 = Closed, Status will be returned according to client language provided.

Example

Here is how you use this:

ShipmentStatusResult[] getShipmentStatus(identifyShipment[] ShippingData);

Faults

• No exceptions, just the returned data may contain errors per shipment.

IShippingWCF\getTrackings(ShippingData)

Get Shipment Trackings.

Parameters

Return

Remarks

Parameter:

1. ShippingData: You can provide a list of Shipments to get Shipment Tracking info for them.

Return value: Array of ShipmentTrackingsResult containing TrackingCode and TrackingStati as well as ShipmentActionResult containing ShipmentID, ShipmentRef and TrackingID for identification of shipments, Success flag (1=successfull, -1=not successfull), and Array of Errors (Errorno, Message and StatusCode) in case not being successfull

Tracking Data will be returned according to client language provided.

Example

Here is how you use this:

ShipmentTrackingResult[] getTrackings(identifyShipment[] ShippingData);

Faults

• No exceptions, just the returned data may contain errors per shipment.

IShippingWCF\printDocuments(PrintRequests)

Print Shipment Documents, including DHL ExportDocuments. PrintInternationalDocuments function will return the CN23 also for DHL, if preferred.

Parameters

Return

Remarks

Parameter – Array of PrintRequest:

1. DocType: So far does not have to be specified, for future use.
2. Format: Only Format.Type has to be filled, other values for future use. Availabe values for Format.Type only “PDF”.
3. IDPackage: PackageRefField to identify field of PackageReference, possible values: PackageID, PackageRef or PackageTrackingID. PackageRefValue to transfer value of this field. If empty, only Shipment is identified.
4. IDShipment: ShipmentRefField to identify field of ShipmentReference, possible values:ShipmentID, ShipmentRef or TrackingID. ShipmentRefValue to transfer value of this field.

Return value – Array of printDocumentResult:

1. ActionResult: ShipmentActionResult: Success, Errors, ShipmentID, ShipmentRef and TrackingID for Identification of Shipment
2. DocType: Possible values to be returned so far: “HighValueReport”, “CODTurnInPage”, “DHL ExportDocuments”.
3. Document: Base64-encoded string of PDF document
4. Format: Format.Type = PDF. Size so far A4 for PDF. Other values are irrelevant so far.
5. PackageID: to identify Package by PackageID
6. PackageRef: to identify Package by PackageRef
7. PackageTrackingID: to identify Package by PackageTrackingID

Example

Here is how you use this:

printDocumentsResult[] printDocuments(PrintRequest[] PrintRequests);

Faults

• No exceptions, just the returned data may contain errors per request.

IShippingWCF\printInternationalDocuments(PrintRequests)

Print International Shipment Documents, CN23 (2 documents per page) or CN22 (one document).

Parameters

Return

Remarks

Parameter – Array of PrintRequest:

1. DocType: not relevant so far, will be returned as “CN22” or “CN23” in any case.
2. Format: Only Format.Type has to be filled, other values for future use. Availabe values for Format.Type may be either “GIF” or “PDF”. Format.Size may be set to “CN22” to return CN22 instead of CN23. If more than 7 detail lines, CN23 will be returned anyway.
3. IDPackage: PackageRefField to identify field of PackageReference, possible values: PackageID, PackageRef or PackageTrackingID. PackageRefValue to transfer value of this field. If empty, only Shipment is identified.
4. IDShipment: ShipmentRefField to identify field of ShipmentReference, possible values:ShipmentID, ShipmentRef or TrackingID. ShipmentRefValue to transfer value of this field.

Return value – Array of printDocumentResult:

1. ActionResult: ShipmentActionResult: Success, Errors, ShipmentID, ShipmentRef and TrackingID for Identification of Shipment
2. DocType: returned as “CN22” or “CN23”.
3. Document: Base64-encoded string of CN22/CN23, either PDF or GIF
4. Format: Format.Type = GIF or PDF. Size so far = A4 for GIF, A4/A6 (CN22) for PDF. Other values are irrelevant so far.
5. PackageID: to identify Package by PackageID
6. PackageRef: to identify Package by PackageRef
7. PackageTrackingID: to identify Package by PackageTrackingID

Example

Here is how you use this:

printDocumentsResult[] printInternationalDocuments(PrintRequest[] PrintRequests);

Faults

• No exceptions, just the returned data may contain errors per request.

IShippingWCF\printLabel(PrintRequests)

Print Shipment Label.

Parameters

Return

Remarks

Parameter – Array of PrintRequest:

1. DocType: not relevant so far, will be returned as “Label” in any case.
2. Format: Only Format.Type has to be filled, other values for future use. Availabe values for Format.Type may be either “GIF” or “PDF”.
3. IDPackage: PackageRefField to identify field of PackageReference, possible values: PackageID, PackageRef or PackageTrackingID. PackageRefValue to transfer value of this field. If empty, only Shipment is identified.
4. IDShipment: ShipmentRefField to identify field of ShipmentReference, possible values:ShipmentID, ShipmentRef or TrackingID. ShipmentRefValue to transfer value of this field.

Return value – Array of printDocumentResult:

1. ActionResult: ShipmentActionResult: Success, Errors, ShipmentID, ShipmentRef and TrackingID for Identification of Shipment
2. DocType: returned as “Label”.
3. Document: Base64-encoded string of label, either PDF or GIF
4. Format: Format.Type = GIF or PDF. Size so far = A6 for GIF, A4 for PDF. Other values are irrelevant so far.
5. PackageID: to identify Package by PackageID
6. PackageRef: to identify Package by PackageRef
7. PackageTrackingID: to identify Package by PackageTrackingID

Example

Here is how you use this:

printDocumentsResult[] printLabel(PrintRequest[] PrintRequests);

Faults

• No exceptions, just the returned data may contain errors per request.

IShippingWCF\registerIntDoc(InternationalDoc)

Register/Add International Document Data for Shipment.

Parameters

Return

Remarks

Parameter – Array of IntDocData:

1. IDShipment: to identify Shipment for adding IntDocData: ShipmentRefField to identify field of ShipmentReference, possible values:ShipmentID, ShipmentRef or TrackingID. ShipmentRefValue to transfer value of this field.
2. IDPackage: optionally: PackageRefField to identify field of PackageReference, possible values: PackageID, PackageRef or PackageTrackingID. PackageRefValue to transfer value of this field. If empty, only Shipment is identified.
3. InternationalDoc: The International Document Data, see also description of function: registerShipments

Return value – Array of printDocumentResult:

1. ActionResult: ShipmentActionResult: Success, Errors, ShipmentID, ShipmentRef and TrackingID for Identification of Shipment
2. DocType: returned as “CN22” or “CN23”.
3. Document: Base64-encoded string of CN22/CN23, either PDF or GIF
4. Format: Format.Type = GIF or PDF. Format.Size = CN22 or CN23.
5. PackageID: to identify Package by PackageID
6. PackageRef: to identify Package by PackageRef
7. PackageTrackingID: to identify Package by PackageTrackingID

Example

Here is how you use this:

printDocumentsResult[] registerIntDoc(IntDocData[] InternationalDoc);

Faults

• No exceptions, just the returned data may be empty.

IShippingWCF\registerShipments(ShippingData)

Register Forward and Return Shipments.

Parameters

Return

Remarks

Parameter – Array of Shipment:

1. CEPID: required – Carrier specification, possible values so far: UPS, PA1, DHL.
2. ConsignerID: required – Consigner ID at ParcelOne , usually “1”, if only one consigner.
3. CostCenter: optional – only for client reference.
4. DocumentFormat: required – only Format.Type = “PDF” needed.
5. LabelFormat: required – only Format.Type = either “GIF” or “PDF” needed.
6. MandatorID: required – Mandator ID at ParcelOne , usually “1”, if only one mandator.
7. Other1: optional – only for client reference.
8. Other2: optional – only for client reference.
9. Other3: optional – only for client reference.
10. Packages: required – ShipmentPackage data, see definition below.
11. PrintDocuments: required – Flag to indicate, if Documents (for DHL also Export Documents) should be returned with this request (0=no, 1=yes).
12. PrintLabel: required – Flag to indicate, if Label should be returned with this request (0=no, 1=yes).
13. ProductID: required – Product specification, in accordance with Carrier specification..
14. ReturnCharges: optional – to return Charges (0=no (default), 1=yes).
15. MaxCharges: optional – to specify maximum amount charge, over maximum will refuse the shipment.
16. ReturnShipmentIndicator: required – 0 = Forward Shipment, all values > 0 = Return Shipment. For UPS the following are available: 2-Print and Mail Return Label by UPS; 3-Return Service 1-Attempt; 5-Return Service 3-Attempt; 8-Electronic Return Label by URL; 9-Print Return Label. For DHL and Parcel One so far not available.
17. Services: optional – ShipmentService data, see definition below.
18. ShipToData: required – ShipTo Data – ( = ShipFrom Data with Return Shipments), see definition below.
19. ShipFromData: optional – ShipFrom Data – only for special purposes, usually ConsignerID has to be provided. Requires special agreement with ParcelOne .
20. ShipmentID: required – ShipmentID, if Shipping successfull, this will be overwritten/assigned.
21. ShipmentRef: required – ShipmentRef for identification of shipment by client.
22. Software: required – Software specification of client, if possible with version number.

Parameter ShipmentPackage – Package:

1. IntDocData: optional/required – see definition below
2. PackageDimensions: optional/required – Dimensions: Height, Length, Width, Measurement=”cm”.
3. PackageID: optional – will be overwritten if shipment successfull.
4. PackageRef: optional – to identify package by client.
5. PackageType: required for UPS – UPS: Package Type = “02” for “Package”.
6. PackageVolume: optional/required – Measurement: Unit = “ltr”, Value = volume in ltr.
7. PackageWeight: required – Measurement: Unit = “kg”, Value = weight in kg.
8. Remarks: optional for Forward Shipments, required for UPS Return Shipments = Contents Description, like: “goods”.
9. Services: optional – Services per Package, see definition below.

Parameter IntDocData- IntDoc:

1. Certificate: 0 = no, 1=yes.
2. CertificateNo: optional – Certificate No.
3. Comments: optional – will be overwritten if shipment successfull.
4. ConsignerCustomsID: optional – to identify package by client.
5. ContentsDesc: required – Array of IntDocContents, see Definition below.
6. Currency: optional, default=EUR – Currency for values.
7. Date: optional, default=today – Date on CN23.
8. Explanation: optional – only for client reference.
9. Invoice: 0 = no, 1=yes.
10. InvoiceNo: optional – Invoice No.
11. InternationalDocumentFormat: required – only Format.Type = “PDF” or “GIF” needed. Format.Size may be set to “CN22” to return CN22 instead of CN23.
12. ItemCategory: optional – Item Category, possible values:1-Gift, 2-Documents, 3-Commercial Sample, 4-Returned Goods, 5-Other
13. License: 0 = no, 1=yes.
14. LicenseNo: optional – License No.
15. OfficeOfOrigin: optional – Office Of Origin.
16. Postage: optional – Postage Amount.
17. PrintInternationalDocuments: required – 0=Save Int.Doc.Data only or 1=return also printable CN23.
18. ShipToRef: optional – Receiver Reference on CN23.
19. TotalValue: optional – Total Value amount.
20. TotalWeightkg: optional – Total Weight Amount in kg.
21. NonDeliveryInstruction: optional (on some versions of CN23: Values: Treat as abandoned, Return to sender) – not used yet, for future use.
22. ServiceLevel: optional (on some versions of CN23: Values: PRI, …) – not used yet, for future use.
23. ValidatedForExport: optional (on some versions of CN23: Values: 0=NO, 1=YES) – not used yet, for future use.

Parameter ContentsDesc – Array of IntDocContents:

1. Contents: Contents description.
2. ItemValue: Value of Item.
3. NetWeight: NetWeight of item.
4. Origin: Origin of Item: Alpha-2-code Country abbreviation (ISO 3166-1).
5. Quantity: Quantity of Item.
6. TariffNumber: TariffNumber of Item.

Parameter Services – Array of ShipmentService:

1. Parameters: optional – so far not in use, for future use.
2. ServiceID: required – Service ID, e.g. NN for COD, WERT for insurance, SA for Saturday Delivery, etc.
3. Value: optional – Currency and Value specification, e.g. for Insurance or COD.

Parameter CEPSpecials – Array of CEPSpecial:

1. Key: required – for DHL so far: Key: PRINTONLYIFCODEABLE, Value: 1 – will return label only in case LEITCODE could be found to avoid Surcharge for not codable addresses
2. Value: optional – value according to requirements of CEP

Parameter – ShipTo:

1. BranchID: optional – Branch or Pickup ID of Carrier. If PUDO-Shipping, then PUDO-Number must be provided here.
2. CEPCustID: optional – Carrier Customer ID of Receiver, not in use yet, for future use.
3. CustomsID: optional – Customs ID of client.
4. Name1: required – First name line.
5. Name2: optional – second name line.
6. Name3: optional – third name line.
7. PrivateAddressIndicator: optional/required – 1=Private Address, 0=B2B-Address.
8. Reference: optional – Receiver Reference.
9. SalesTaxID: optional – Sales Tax ID.
10. ShipmentAddress: required – ShipTo address, see definition below.
11. ShipmentContact: required – ShipTo contact, see definition below.

Parameter ShipmentAdress – Address:

1. City: required – City.
2. Country: required – Alpha-2-code Country abbreviation (ISO 3166-1).
3. District: optional – District, often printed under StreetNo and Streetno.
4. PostalCode: optional – ZIPCode.
5. State: required – State, often printed under PostalCode and City.
6. Street: optional/required – Street.
7. Streetno: optional/required – Streetno.

Parameter ShipmentContact – Contact:

1. AttentionName: optional – Attention name.
2. BirthDate: optional – Birth date, not used yet.
3. Company: optional – Company.
4. ContactPerson: optional – Contact person.
5. Email: required – email of receiver.
6. Fax: optional – fax.
7. FirstName: optional – firstname.
8. LastName: optional – lastname.
9. Mobile: optional – mobile phone number.
10. Phone: optional – phone number.
11. Salutation: optional – salutation.

Return value – Array of ShipmentResult:

1. ActionResult: ShipmentActionResult: Success, Errors, ShipmentID, ShipmentRef and TrackingID for Identification of Shipment
2. Charges: Array of Amount (Currency,Value and Description) – to return price information.
3. DocumentsAvailable: Number of documents that have been produced for this shipment.
4. DocumentsResults: Array of ShipmentDocumentsResult: Charges, DocType, Base64-encoded string of GIF or PDF document, Format, PackageID for Package Identification, ShipmentID and TrackingID for Shipment Identificaiton, DocumentID for Document Identification (e.g. ParcelOne Retoure Trackno)
5. InternationalDocumentsAvailable: Number of International documents that have been produced for this shipment.
6. InternationalDocumentsNeeded: Values: -1 = has not been checked, 0 = not needed, 1 = neeeded. Returned independently of whether Customs Data were provided or not.
7. LabelsAvailable: Number of labels that have been produced for this shipment.
8. LabelURL: URL to download Label and Documents, for UPS Return Shipments with Download-URL to include in email for receiver.
9. PackageResults: Array of ShipmentPackageResult: Charges for Package, DocType, Format, Label, TrackingURL, PackageID and PackageRef for Package Identification, ShipmentID and TrackingID for Shipment Identificaiton

Example

Here is how you use this:

ShipmentResult[] registerShipments(Shipment[] ShippingData);

Faults

• No exceptions, just the returned data may contain errors per request.

IShippingWCF\voidShipments(ShippingData)

Void / Cancel Shipments.

Parameters

Return

Remarks

Parameter:

1. ShippingData: You can provide a list of Shipments. Only those in your list will be voided/cancelled if possible.

Return value: Array of ShipmentActionResult containing ShipmentID, ShipmentRef and TrackingID for identification of shipments, Success flag (1=successfull, -1=not successfull), and Array of Errors (Errorno, Message and StatusCode) in case not being successfull

Example

Here is how you use this:

ShipmentActionResult[] voidShipments(identifyShipment[] ShippingData);

Faults

• No exceptions, just the returned data may contain errors per shipment.

Address Data.

Members

Xml Representation

					<Address>
					<City>…</City>
					<Country>…</Country>
					<District>…</District>
					<PostalCode>…</PostalCode>
					<State>…</State>
					<Street>…</Street>
					<Streetno>…</Streetno>
					</Address>
					

Amounts Information.

Members

Xml Representation

					<Amount>
					<Currency>…</Currency>
					<Description>…</Description>
					<Value>…</Value>
					</Amount>

Array Element

Xml Representation

<ArrayOfAmount>
    <Amount>…</Amount>
    <Amount>…</Amount>
    <Amount>…</Amount>
    …
</ArrayOfAmount>

Array Element

Xml Representation

<ArrayOfCEP>
    <CEP>…</CEP>
    <CEP>…</CEP>
    <CEP>…</CEP>
    …
</ArrayOfCEP>

Array Element

Xml Representation

<ArrayOfCEPSpecial>
    <CEPSpecial>…</CEPSpecial>
    <CEPSpecial>…</CEPSpecial>
    <CEPSpecial>…</CEPSpecial>
    …
</ArrayOfCEPSpecial>

Array Element

Xml Representation

<ArrayOfCharges>
    <Charges>…</Charges>
    <Charges>…</Charges>
    <Charges>…</Charges>
    …
</ArrayOfCharges>

Array Element

Xml Representation

<ArrayOfChargesPackageResult>
    <ChargesPackageResult>…</ChargesPackageResult>
    <ChargesPackageResult>…</ChargesPackageResult>
    <ChargesPackageResult>…</ChargesPackageResult>
    …
</ArrayOfChargesPackageResult>

Array Element

Xml Representation

<ArrayOfChargesResult>
    <ChargesResult>…</ChargesResult>
    <ChargesResult>…</ChargesResult>
    <ChargesResult>…</ChargesResult>
    …
</ArrayOfChargesResult>

Array Element

Xml Representation

<ArrayOfClosedResult>
    <ClosedResult>…</ClosedResult>
    <ClosedResult>…</ClosedResult>
    <ClosedResult>…</ClosedResult>
    …
</ArrayOfClosedResult>

Array Element

Xml Representation

<ArrayOfConsigner>
    <Consigner>…</Consigner>
    <Consigner>…</Consigner>
    <Consigner>…</Consigner>
    …
</ArrayOfConsigner>

Array Element

Xml Representation

<ArrayOfCustomer>
    <Customer>…</Customer>
    <Customer>…</Customer>
    <Customer>…</Customer>
    …
</ArrayOfCustomer>

Array Element

Xml Representation

<ArrayOfError>
    <Error>…</Error>
    <Error>…</Error>
    <Error>…</Error>
    …
</ArrayOfError>

Array Element

Xml Representation

<ArrayOfidentifyShipment>
    <identifyShipment>…</identifyShipment>
    <identifyShipment>…</identifyShipment>
    <identifyShipment>…</identifyShipment>
    …
</ArrayOfidentifyShipment>

Array Element

Xml Representation

<ArrayOfIntDocContents>
    <IntDocContents>…</IntDocContents>
    <IntDocContents>…</IntDocContents>
    <IntDocContents>…</IntDocContents>
    …
</ArrayOfIntDocContents>

Array Element

Xml Representation

<ArrayOfIntDocData>
    <IntDocData>…</IntDocData>
    <IntDocData>…</IntDocData>
    <IntDocData>…</IntDocData>
    …
</ArrayOfIntDocData>

Array Element

Xml Representation

<ArrayOfprintDocumentsResult>
    <printDocumentsResult>…</printDocumentsResult>
    <printDocumentsResult>…</printDocumentsResult>
    <printDocumentsResult>…</printDocumentsResult>
    …
</ArrayOfprintDocumentsResult>

Array Element

Xml Representation

<ArrayOfPrintRequest>
    <PrintRequest>…</PrintRequest>
    <PrintRequest>…</PrintRequest>
    <PrintRequest>…</PrintRequest>
    …
</ArrayOfPrintRequest>

Array Element

Xml Representation

<ArrayOfProduct>
    <Product>…</Product>
    <Product>…</Product>
    <Product>…</Product>
    …
</ArrayOfProduct>

Array Element

Xml Representation

<ArrayOfProfile>
    <Profile>…</Profile>
    <Profile>…</Profile>
    <Profile>…</Profile>
    …
</ArrayOfProfile>

Array Element

Xml Representation

<ArrayOfService>
    <Service>…</Service>
    <Service>…</Service>
    <Service>…</Service>
    …
</ArrayOfService>

Array Element

Xml Representation

<ArrayOfShipment>
    <Shipment>…</Shipment>
    <Shipment>…</Shipment>
    <Shipment>…</Shipment>
    …
</ArrayOfShipment>

Array Element

Xml Representation

<ArrayOfShipmentActionResult>
    <ShipmentActionResult>…</ShipmentActionResult>
    <ShipmentActionResult>…</ShipmentActionResult>
    <ShipmentActionResult>…</ShipmentActionResult>
    …
</ArrayOfShipmentActionResult>

Array Element

Xml Representation

<ArrayOfShipmentDocumentsResult>
    <ShipmentDocumentsResult>…</ShipmentDocumentsResult>
    <ShipmentDocumentsResult>…</ShipmentDocumentsResult>
    <ShipmentDocumentsResult>…</ShipmentDocumentsResult>
    …
</ArrayOfShipmentDocumentsResult>

Array Element

Xml Representation

<ArrayOfShipmentPackage>
    <ShipmentPackage>…</ShipmentPackage>
    <ShipmentPackage>…</ShipmentPackage>
    <ShipmentPackage>…</ShipmentPackage>
    …
</ArrayOfShipmentPackage>

Array Element

Xml Representation

<ArrayOfShipmentPackageResult>
    <ShipmentPackageResult>…</ShipmentPackageResult>
    <ShipmentPackageResult>…</ShipmentPackageResult>
    <ShipmentPackageResult>…</ShipmentPackageResult>
    …
</ArrayOfShipmentPackageResult>

Array Element

Xml Representation

<ArrayOfShipmentResult>
    <ShipmentResult>…</ShipmentResult>
    <ShipmentResult>…</ShipmentResult>
    <ShipmentResult>…</ShipmentResult>
    …
</ArrayOfShipmentResult>

Array Element

Xml Representation

<ArrayOfShipmentService>
    <ShipmentService>…</ShipmentService>
    <ShipmentService>…</ShipmentService>
    <ShipmentService>…</ShipmentService>
    …
</ArrayOfShipmentService>

Array Element

Xml Representation

<ArrayOfShipmentStatusResult>
    <ShipmentStatusResult>…</ShipmentStatusResult>
    <ShipmentStatusResult>…</ShipmentStatusResult>
    <ShipmentStatusResult>…</ShipmentStatusResult>
    …
</ArrayOfShipmentStatusResult>

Array Element

Xml Representation

<ArrayOfShipmentTrackingResult>
    <ShipmentTrackingResult>…</ShipmentTrackingResult>
    <ShipmentTrackingResult>…</ShipmentTrackingResult>
    <ShipmentTrackingResult>…</ShipmentTrackingResult>
    …
</ArrayOfShipmentTrackingResult>

Array Element

Xml Representation

<ArrayOfTrackingResult>
    <TrackingResult>…</TrackingResult>
    <TrackingResult>…</TrackingResult>
    <TrackingResult>…</TrackingResult>
    …
</ArrayOfTrackingResult>

Carrier Information.

Members

Xml Representation

<CEP>
    <CEPID>…</CEPID>
    <CEPLongname>…</CEPLongname>
    <Default>…</Default>
    <Products>…</Products>
</CEP>

CEPSpecials Information.

Members

Xml Representation

<CEPSpecial>
    <Key>…</Key>
    <Value>…</Value>
</CEPSpecial>

Charges Request Data.

Members

Xml Representation

<Charges>
    <CEPID>…</CEPID>
    <ConsignerID>…</ConsignerID>
    <IDShipment>…</IDShipment>
    <MandatorID>…</MandatorID>
    <Packages>…</Packages>
    <PrivateAddressIndicator>…</PrivateAddressIndicator>
    <ProductID>…</ProductID>
    <ReturnShipmentIndicator>…</ReturnShipmentIndicator>
    <Services>…</Services>
    <ShipToAddress>…</ShipToAddress>
</Charges>

Charges Parcel Results Data.

Members

Xml Representation

<ChargesPackageResult>
    <Charges>…</Charges>
    <PackageID>…</PackageID>
    <PackageRef>…</PackageRef>
    <ShipmentID>…</ShipmentID>
    <TrackingID>…</TrackingID>
</ChargesPackageResult>

Charges Result Data.

Members

Xml Representation

<ChargesResult>
    <ActionResult>…</ActionResult>
    <PackageResults>…</PackageResults>
    <Remarks>…</Remarks>
    <ShipmentCharges>…</ShipmentCharges>
    <TotalCharges>…</TotalCharges>
</ChargesResult>

Closed Shipments Result Data.

Members

Xml Representation

<ClosedResult>
    <CEP>…</CEP>
    <ClosedStamp>…</ClosedStamp>
    <printDocumentResult>…</printDocumentResult>
</ClosedResult>

Consigner Information.

Members

Xml Representation

<Consigner>
    <ConsignerID>…</ConsignerID>
    <Default>…</Default>
    <Shortname>…</Shortname>
</Consigner>

Contact Request Data.

Members

Xml Representation

<Contact>
    <AttentionName>…</AttentionName>
    <BirthDate>…</BirthDate>
    <Company>…</Company>
    <ContactPerson>…</ContactPerson>
    <Email>…</Email>
    <Fax>…</Fax>
    <FirstName>…</FirstName>
    <LastName>…</LastName>
    <Mobile>…</Mobile>
    <Phone>…</Phone>
    <Salutation>…</Salutation>
</Contact>

Customer Info.

Members

Xml Representation

<Customer>
    <Consigners>…</Consigners>
    <CustomerID>…</CustomerID>
    <Default>…</Default>
    <MandatorID>…</MandatorID>
    <Shortname>…</Shortname>
    <Status>…</Status>
    <StatusID>…</StatusID>
</Customer>

Dimensions Information.

Members

Xml Representation

<Dimensions>
    <Height>…</Height>
    <Length>…</Length>
    <Measurement>…</Measurement>
    <Width>…</Width>
</Dimensions>

Error Identification.

Members

Xml Representation

<Error>
    <ErrorNo>…</ErrorNo>
    <Message>…</Message>
    <StatusCode>…</StatusCode>
</Error>

Format Information.

Members

Xml Representation

<Format>
    <Height>…</Height>
    <Orientation>…</Orientation>
    <Size>…</Size>
    <Type>…</Type>
    <Unit>…</Unit>
    <Width>…</Width>
</Format>

Parcel Identification.

Members

Xml Representation

<identifyPackage>
    <PackageRefField>…</PackageRefField>
    <PackageRefValue>…</PackageRefValue>
</identifyPackage>

Shipment Identification.

Members

Xml Representation

<identifyShipment>
    <ShipmentRefField>…</ShipmentRefField>
    <ShipmentRefValue>…</ShipmentRefValue>
</identifyShipment>

International Documents Request Data.

Members

Xml Representation

<IntDoc>
    <Certificate>…</Certificate>
    <CertificateNo>…</CertificateNo>
    <Comments>…</Comments>
    <ConsignerCustomsID>…</ConsignerCustomsID>
    <ContentsDesc>…</ContentsDesc>
    <Currency>…</Currency>
    <Date>…</Date>
    <Explanation>…</Explanation>
    <InternationalDocumentFormat>…</InternationalDocumentFormat>
    <Invoice>…</Invoice>
    <InvoiceNo>…</InvoiceNo>
    <ItemCategory>…</ItemCategory>
    <License>…</License>
    <LicenseNo>…</LicenseNo>
    <NonDeliveryInstruction>…</NonDeliveryInstruction>
    <OfficeOfOrigin>…</OfficeOfOrigin>
    <Postage>…</Postage>
    <PrintInternationalDocuments>…</PrintInternationalDocuments>
    <ServiceLevel>…</ServiceLevel>
    <ShipToRef>…</ShipToRef>
    <TotalValue>…</TotalValue>
    <TotalWeightkg>…</TotalWeightkg>
    <ValidatedForExport>…</ValidatedForExport>
</IntDoc>

International Documents Contents Request Data.

Members

Xml Representation

<IntDocContents>
    <Contents>…</Contents>
    <ItemValue>…</ItemValue>
    <NetWeight>…</NetWeight>
    <Origin>…</Origin>
    <Quantity>…</Quantity>
    <TariffNumber>…</TariffNumber>
</IntDocContents>

International Documents Request Data.

Members

Xml Representation

<IntDocData>
    <IDPackage>…</IDPackage>
    <IDShipment>…</IDShipment>
    <InternationalDoc>…</InternationalDoc>
</IntDocData>

Measurements Information.

Members

Xml Representation

<Measurement>
    <Unit>…</Unit>
    <Value>…</Value>
</Measurement>

Shipment Documents Print Result Data.

Members

Xml Representation

<printDocumentsResult>
    <ActionResult>…</ActionResult>
    <DocType>…</DocType>
    <Document>…</Document>
    <Format>…</Format>
    <PackageID>…</PackageID>
    <PackageRef>…</PackageRef>
    <PackageTrackingID>…</PackageTrackingID>
</printDocumentsResult>

Print Request Data.

Members

Xml Representation

<PrintRequest>
    <DocType>…</DocType>
    <Format>…</Format>
    <IDPackage>…</IDPackage>
    <IDShipment>…</IDShipment>
</PrintRequest>

Product Information.

Members

Xml Representation

<Product>
    <Default>…</Default>
    <ProductID>…</ProductID>
    <ProductName>…</ProductName>
    <Services>…</Services>
</Product>

Profile for a mandator.

Members

Xml Representation

<Profile>
    <CEPs>…</CEPs>
    <Consigners>…</Consigners>
    <Default>…</Default>
    <MandatorID>…</MandatorID>
    <MandatorShortname>…</MandatorShortname>
</Profile>

Services Information.

Members

Xml Representation

<Service>
    <AmountNeeded>…</AmountNeeded>
    <CurrencyNeeded>…</CurrencyNeeded>
    <Default>…</Default>
    <ServiceID>…</ServiceID>
    <ServiceName>…</ServiceName>
</Service>

ShipFrom / Consigner Data – only to be used with special agreement!

Members

Xml Representation

<ShipFrom>
    <CustomsID>…</CustomsID>
    <Name1>…</Name1>
    <Name2>…</Name2>
    <Name3>…</Name3>
    <Reference>…</Reference>
    <SalesTaxID>…</SalesTaxID>
    <ShipmentAddress>…</ShipmentAddress>
    <ShipmentContact>…</ShipmentContact>
</ShipFrom>

Shipment Request Data.

Members

Xml Representation

<Shipment>
    <CEPID>…</CEPID>
    <CEPSpecials>…</CEPSpecials>
    <ConsignerID>…</ConsignerID>
    <CostCenter>…</CostCenter>
    <DocumentFormat>…</DocumentFormat>
    <LabelFormat>…</LabelFormat>
    <MandatorID>…</MandatorID>
    <MaxCharges>…</MaxCharges>
    <Other1>…</Other1>
    <Other2>…</Other2>
    <Other3>…</Other3>
    <Packages>…</Packages>
    <PrintDocuments>…</PrintDocuments>
    <PrintLabel>…</PrintLabel>
    <ProductID>…</ProductID>
    <ReturnCharges>…</ReturnCharges>
    <ReturnShipmentIndicator>…</ReturnShipmentIndicator>
    <Services>…</Services>
    <ShipFromData>…</ShipFromData>
    <ShipToData>…</ShipToData>
    <ShipmentID>…</ShipmentID>
    <ShipmentRef>…</ShipmentRef>
    <Software>…</Software>
</Shipment>

Shipment Action Results.

Members

Xml Representation

<ShipmentActionResult>
    <Errors>…</Errors>
    <ShipmentID>…</ShipmentID>
    <ShipmentRef>…</ShipmentRef>
    <Success>…</Success>
    <TrackingID>…</TrackingID>
</ShipmentActionResult>

Shipment Documents Results Data.

Members

Xml Representation

<ShipmentDocumentsResult>
    <Charges>…</Charges>
    <DocType>…</DocType>
    <Document>…</Document>
    <Format>…</Format>
    <PackageID>…</PackageID>
    <ShipmentID>…</ShipmentID>
    <TrackingID>…</TrackingID>
</ShipmentDocumentsResult>

Parcel Information.

Members

Xml Representation

<ShipmentPackage>
    <IntDocData>…</IntDocData>
    <PackageDimensions>…</PackageDimensions>
    <PackageID>…</PackageID>
    <PackageRef>…</PackageRef>
    <PackageType>…</PackageType>
    <PackageVolume>…</PackageVolume>
    <PackageWeight>…</PackageWeight>
    <Remarks>…</Remarks>
    <Services>…</Services>
</ShipmentPackage>

Shipment Parcel Results Data.

Members

Xml Representation

<ShipmentPackageResult>
    <Charges>…</Charges>
    <DocType>…</DocType>
    <Format>…</Format>
    <Label>…</Label>
    <PackageID>…</PackageID>
    <PackageRef>…</PackageRef>
    <ShipmentID>…</ShipmentID>
    <TrackingID>…</TrackingID>
</ShipmentPackageResult>

Shipment Results Data.

Members

Xml Representation

<ShipmentResult>
    <ActionResult>…</ActionResult>
    <Charges>…</Charges>
    <DocumentsAvailable>…</DocumentsAvailable>
    <DocumentsResults>…</DocumentsResults>
    <InternationalDocumentsAvailable>…</InternationalDocumentsAvailable>
    <InternationalDocumentsNeeded>…</InternationalDocumentsNeeded>
    <InternationalDocumentsResults>…</InternationalDocumentsResults>
    <LabelURL>…</LabelURL>
    <LabelsAvailable>…</LabelsAvailable>
    <PackageResults>…</PackageResults>
    <TotalCharges>…</TotalCharges>
</ShipmentResult>

Services Information.

Members

Xml Representation

<ShipmentService>
    <Parameters>…</Parameters>
    <ServiceID>…</ServiceID>
    <Value>…</Value>
</ShipmentService>

Shipment Status Results.

Members

Xml Representation

<ShipmentStatusResult>
    <ActionResult>…</ActionResult>
    <ShipmentStatus>…</ShipmentStatus>
    <ShipmentStatusCode>…</ShipmentStatusCode>
    <LastTrackingNo>…</LastTrackingNo>
    <LastCEP>…</LastCEP>
</ShipmentStatusResult>

Shipment Trackings Results.

Members

Xml Representation

<ShipmentTrackingResult>
    <ActionResult>…</ActionResult>
    <Trackings>…</Trackings>
</ShipmentTrackingResult>

Shipto / Receiver Data.

Members

Xml Representation

<ShipTo>
    <BranchID>…</BranchID>
    <CEPCustID>…</CEPCustID>
    <CustomsID>…</CustomsID>
    <Name1>…</Name1>
    <Name2>…</Name2>
    <Name3>…</Name3>
    <PrivateAddressIndicator>…</PrivateAddressIndicator>
    <Reference>…</Reference>
    <SalesTaxID>…</SalesTaxID>
    <ShipmentAddress>…</ShipmentAddress>
    <ShipmentContact>…</ShipmentContact>
</ShipTo>

Shipment Tracking Result Data.

Members

Xml Representation

<TrackingResult>
    <TrackingDateTime>…</TrackingDateTime>
    <TrackingStatus>…</TrackingStatus>
    <TrackingStatusCode>…</TrackingStatusCode>
</TrackingResult>

Array Element

Xml Representation

<ArrayOfstring>
    <string>…</string>
    <string>…</string>
    <string>…</string>
    …
</ArrayOfstring>