ShippingWCF API - PARCEL.ONE

SOAP Services - Last Update 2018-03-09

NameDescription
IShippingWCF

Parcel.One provides you with a WCF API for implementing an interface to Parcel.One 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

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.

Types

NameNamespaceDescription
Addresshttp://schemas.datacontract.org/2004/07/ShippingWCF

Address Data.

Amounthttp://schemas.datacontract.org/2004/07/ShippingWCF

Amounts Information.

ArrayOfAmounthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfCEPhttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfCEPSpecialhttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfChargeshttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfChargesPackageResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfChargesResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfClosedResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfConsignerhttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfCustomerhttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfErrorhttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfidentifyShipmenthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfIntDocContentshttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfIntDocDatahttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfprintDocumentsResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfPrintRequesthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfProducthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfProfilehttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfServicehttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfShipmenthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfShipmentActionResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfShipmentDocumentsResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfShipmentPackagehttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfShipmentPackageResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfShipmentResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfShipmentServicehttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfShipmentStatusResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfShipmentTrackingResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
ArrayOfTrackingResulthttp://schemas.datacontract.org/2004/07/ShippingWCF
CEPhttp://schemas.datacontract.org/2004/07/ShippingWCF

Carrier Information.

CEPSpecialhttp://schemas.datacontract.org/2004/07/ShippingWCF

CEPSpecials Information.

Chargeshttp://schemas.datacontract.org/2004/07/ShippingWCF

Charges Request Data.

ChargesPackageResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Charges Parcel Results Data.

ChargesResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Charges Result Data.

ClosedResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Closed Shipments Result Data.

Consignerhttp://schemas.datacontract.org/2004/07/ShippingWCF

Consigner Information.

Contacthttp://schemas.datacontract.org/2004/07/ShippingWCF

Contact Request Data.

Customerhttp://schemas.datacontract.org/2004/07/ShippingWCF

Customer Info.

Dimensionshttp://schemas.datacontract.org/2004/07/ShippingWCF

Dimensions Information.

Errorhttp://schemas.datacontract.org/2004/07/ShippingWCF

Error Identification.

Formathttp://schemas.datacontract.org/2004/07/ShippingWCF

Format Information.

identifyPackagehttp://schemas.datacontract.org/2004/07/ShippingWCF

Parcel Identification.

identifyShipmenthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Identification.

IntDochttp://schemas.datacontract.org/2004/07/ShippingWCF

International Documents Request Data.

IntDocContentshttp://schemas.datacontract.org/2004/07/ShippingWCF

International Documents Contents Request Data.

IntDocDatahttp://schemas.datacontract.org/2004/07/ShippingWCF

International Documents Request Data.

Measurementhttp://schemas.datacontract.org/2004/07/ShippingWCF

Measurements Information.

printDocumentsResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Documents Print Result Data.

PrintRequesthttp://schemas.datacontract.org/2004/07/ShippingWCF

Print Request Data.

Producthttp://schemas.datacontract.org/2004/07/ShippingWCF

Product Information.

Profilehttp://schemas.datacontract.org/2004/07/ShippingWCF

Profile for a mandator.

Servicehttp://schemas.datacontract.org/2004/07/ShippingWCF

Services Information.

ShipFromhttp://schemas.datacontract.org/2004/07/ShippingWCF

ShipFrom / Consigner Data.

Shipmenthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Request Data.

ShipmentActionResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Action Results.

ShipmentDocumentsResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Documents Results Data.

ShipmentPackagehttp://schemas.datacontract.org/2004/07/ShippingWCF

Parcel Information.

ShipmentPackageResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Parcel Results Data.

ShipmentResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Results Data.

ShipmentServicehttp://schemas.datacontract.org/2004/07/ShippingWCF

Services Information.

ShipmentStatusResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Status Results.

ShipmentTrackingResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Trackings Results.

ShipTohttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipto / Receiver Data.

TrackingResulthttp://schemas.datacontract.org/2004/07/ShippingWCF

Shipment Tracking Result Data.

ArrayOfstringhttp://schemas.microsoft.com/2003/10/Serialization/Arrays


SOAP Services


IShippingWCF

Parcel.One provides you with a WCF API for implementing an interface to Parcel.One 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

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
NameDescription
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. )

getCEPs(Mandator, level, Countries)

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

getCharges(ChargesData)

Get Shipment Charges.

getClosableShipments(Mandator, Consigner, CEP)

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

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.

getCustomers()

Get the availabe Customer's Information and status.

getDateTime()

Get Server DateTime to compare with Client DateTime.

getProducts(Mandator, CEP, level, Countries)

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

getProfiles(level, Countries)

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

getServices(Mandator, CEP, Product, Countries)

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

getShipmentStatus(ShippingData)

Get Shipment Status.

getTrackings(ShippingData)

Get Shipment Trackings.

printDocuments(PrintRequests)

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

printInternationalDocuments(PrintRequests)

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

printLabel(PrintRequests)

Print Shipment Label.

registerIntDoc(InternationalDoc)

Register/Add International Document Data for Shipment.

registerShipments(ShippingData)

Register Forward and Return Shipments.

voidShipments(ShippingData)

Void / Cancel Shipments.

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://shippingwcfsandbox.awiwe.net/shippingwcf.svc
  • WSDL: https://shippingwcfsandbox.awiwe.net/shippingwcf.svc?wsdl
You can reach the Production-Mode under ...
  • Service: https://shippingwcf.awiwe.net/shippingwcf.svc
  • WSDL: https://shippingwcf.awiwe.net/shippingwcf.svc?wsdl
Please, use the Sandbox mode to test your client application thoroughly before switching to Production mode. In Sandbox mode all data will be saved to a separate database on our server.




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
ClosedStamp
Type: string
Mandator
Type: string
Consigner
Type: string
CEP
Type: string
Format
Type: Format
Shipments
Type: ArrayOfidentifyShipment
Return
Type: ArrayOfClosedResult
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.

Return value: Array of ClosedResult containing CEP,ClosedStamp and printDocumentsResult, will contain a separate printDocumentsResult for each Carrier. The closable shipment data may be returned as a PDF file as Base64-encoded string or as a CSV file as Base64-encoded string. The fields in CSV: ShipmentID;ShipmentRef;TrackingID;Mandator;Consigner;CEP;Product;Packages;Weight;Name1;Name2;Name3;Country;Zip;City;Street;Houseno

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
Mandator
Type: string
level
Type: int
Countries
Type: ArrayOfstring
Return
Type: ArrayOfCEP
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
ChargesData
Type: ArrayOfCharges
Return
Type: ArrayOfChargesResult
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
Mandator
Type: string
Consigner
Type: string
CEP
Type: string
Return
Type: ArrayOfprintDocumentsResult
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.

Return value: Array of printDocumentsResult, will contain a separate printDocumentsResult for each Carrier. The closable shipment data will be returned as a CSV file as Base64-encoded string. The fields in CSV: ShipmentID;ShipmentRef;TrackingID;Mandator;Consigner;CEP;Product;Packages;Weight;Name1;Name2;Name3;Country;Zip;City;Street;Houseno

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
Mandator
Type: string
Consigner
Type: string
CEP
Type: string
StartDate
Type: string
EndDate
Type: string
Return
Type: ArrayOfstring
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.

Return value: Array of strings of ClosedStamps. A ClosedStamp consists of DateTimeStamp followed by the CEP, like e.g. "20150520134557UPS".

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
Type: ArrayOfCustomer
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
Type: dateTime
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
Mandator
Type: string
CEP
Type: string
level
Type: int
Countries
Type: ArrayOfstring
Return
Type: ArrayOfProduct
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
level
Type: int
Countries
Type: ArrayOfstring
Return
Type: ArrayOfProfile
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
Mandator
Type: string
CEP
Type: string
Product
Type: string
Countries
Type: ArrayOfstring
Return
Type: ArrayOfService
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
ShippingData
Type: ArrayOfidentifyShipment
Return
Type: ArrayOfShipmentStatusResult
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
ShippingData
Type: ArrayOfidentifyShipment
Return
Type: ArrayOfShipmentTrackingResult
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
PrintRequests
Type: ArrayOfPrintRequest
Return
Type: ArrayOfprintDocumentsResult
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
PrintRequests
Type: ArrayOfPrintRequest
Return
Type: ArrayOfprintDocumentsResult
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
PrintRequests
Type: ArrayOfPrintRequest
Return
Type: ArrayOfprintDocumentsResult
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
InternationalDoc
Type: ArrayOfIntDocData
Return
Type: ArrayOfprintDocumentsResult
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
ShippingData
Type: ArrayOfShipment
Return
Type: ArrayOfShipmentResult
Remarks

Parameter - Array of Shipment:

  1. CEPID: required - Carrier specification, possible values so far: UPS, PA1, DHL.
  2. ConsignerID: required - Consigner ID at Parcel.One , 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 Parcel.One , 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 Parcel.One .
  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 Delivery, not in use yet, for future use.
  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
  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
ShippingData
Type: ArrayOfidentifyShipment
Return
Type: ArrayOfShipmentActionResult
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.


Types


Address Type

Address Data.

Members
Member NameTypeRequiredMaxLengthDescription
CitystringYes40City.
CountrystringYes2Alpha-2-code Country abbreviation (ISO 3166-1).
DistrictstringNo40District or any information to be printed under Postal Code / City.
PostalCodestringNo15Postal Code, required for most countries, but there are exceptions.
StatestringNo30State Information, printed under Postal Code / City and District.
StreetstringNo40Street with or without Streetno, im most cases required.
StreetnostringNo15Streetno, may also be included in Street field.
Xml Representation
					<Address>
					<City>...</City>
					<Country>...</Country>
					<District>...</District>
					<PostalCode>...</PostalCode>
					<State>...</State>
					<Street>...</Street>
					<Streetno>...</Streetno>
					</Address>
					


Amount Type

Amounts Information.

Members
Member NameTypeRequiredMaxLengthDescription
CurrencystringNo33-char-Abbreviation of Currency, e.g. EUR for Euro (Default).
DescriptionstringNoDescription of Amount.
ValuestringYesDecimal(10,2)Actual Amount, Number Format: InvariantInfo.
Xml Representation
					<Amount>
					<Currency>...</Currency>
					<Description>...</Description>
					<Value>...</Value>
					</Amount>


ArrayOfAmount Array

Array Element
Element NameType
AmountAmount
Xml Representation
<ArrayOfAmount>
    <Amount>...</Amount>
    <Amount>...</Amount>
    <Amount>...</Amount>
    ...
</ArrayOfAmount>


ArrayOfCEP Array

Array Element
Element NameType
CEPCEP
Xml Representation
<ArrayOfCEP>
    <CEP>...</CEP>
    <CEP>...</CEP>
    <CEP>...</CEP>
    ...
</ArrayOfCEP>


ArrayOfCEPSpecial Array

Array Element
Element NameType
CEPSpecialCEPSpecial
Xml Representation
<ArrayOfCEPSpecial>
    <CEPSpecial>...</CEPSpecial>
    <CEPSpecial>...</CEPSpecial>
    <CEPSpecial>...</CEPSpecial>
    ...
</ArrayOfCEPSpecial>


ArrayOfCharges Array

Array Element
Element NameType
ChargesCharges
Xml Representation
<ArrayOfCharges>
    <Charges>...</Charges>
    <Charges>...</Charges>
    <Charges>...</Charges>
    ...
</ArrayOfCharges>


ArrayOfChargesPackageResult Array

Array Element
Element NameType
ChargesPackageResultChargesPackageResult
Xml Representation
<ArrayOfChargesPackageResult>
    <ChargesPackageResult>...</ChargesPackageResult>
    <ChargesPackageResult>...</ChargesPackageResult>
    <ChargesPackageResult>...</ChargesPackageResult>
    ...
</ArrayOfChargesPackageResult>


ArrayOfChargesResult Array

Array Element
Element NameType
ChargesResultChargesResult
Xml Representation
<ArrayOfChargesResult>
    <ChargesResult>...</ChargesResult>
    <ChargesResult>...</ChargesResult>
    <ChargesResult>...</ChargesResult>
    ...
</ArrayOfChargesResult>


ArrayOfClosedResult Array

Array Element
Element NameType
ClosedResultClosedResult
Xml Representation
<ArrayOfClosedResult>
    <ClosedResult>...</ClosedResult>
    <ClosedResult>...</ClosedResult>
    <ClosedResult>...</ClosedResult>
    ...
</ArrayOfClosedResult>


ArrayOfConsigner Array

Array Element
Element NameType
ConsignerConsigner
Xml Representation
<ArrayOfConsigner>
    <Consigner>...</Consigner>
    <Consigner>...</Consigner>
    <Consigner>...</Consigner>
    ...
</ArrayOfConsigner>


ArrayOfCustomer Array

Array Element
Element NameType
CustomerCustomer
Xml Representation
<ArrayOfCustomer>
    <Customer>...</Customer>
    <Customer>...</Customer>
    <Customer>...</Customer>
    ...
</ArrayOfCustomer>


ArrayOfError Array

Array Element
Element NameType
ErrorError
Xml Representation
<ArrayOfError>
    <Error>...</Error>
    <Error>...</Error>
    <Error>...</Error>
    ...
</ArrayOfError>


ArrayOfidentifyShipment Array

Array Element
Element NameType
identifyShipmentidentifyShipment
Xml Representation
<ArrayOfidentifyShipment>
    <identifyShipment>...</identifyShipment>
    <identifyShipment>...</identifyShipment>
    <identifyShipment>...</identifyShipment>
    ...
</ArrayOfidentifyShipment>


ArrayOfIntDocContents Array

Array Element
Element NameType
IntDocContentsIntDocContents
Xml Representation
<ArrayOfIntDocContents>
    <IntDocContents>...</IntDocContents>
    <IntDocContents>...</IntDocContents>
    <IntDocContents>...</IntDocContents>
    ...
</ArrayOfIntDocContents>


ArrayOfIntDocData Array

Array Element
Element NameType
IntDocDataIntDocData
Xml Representation
<ArrayOfIntDocData>
    <IntDocData>...</IntDocData>
    <IntDocData>...</IntDocData>
    <IntDocData>...</IntDocData>
    ...
</ArrayOfIntDocData>


ArrayOfprintDocumentsResult Array

Array Element
Element NameType
printDocumentsResultprintDocumentsResult
Xml Representation
<ArrayOfprintDocumentsResult>
    <printDocumentsResult>...</printDocumentsResult>
    <printDocumentsResult>...</printDocumentsResult>
    <printDocumentsResult>...</printDocumentsResult>
    ...
</ArrayOfprintDocumentsResult>


ArrayOfPrintRequest Array

Array Element
Element NameType
PrintRequestPrintRequest
Xml Representation
<ArrayOfPrintRequest>
    <PrintRequest>...</PrintRequest>
    <PrintRequest>...</PrintRequest>
    <PrintRequest>...</PrintRequest>
    ...
</ArrayOfPrintRequest>


ArrayOfProduct Array

Array Element
Element NameType
ProductProduct
Xml Representation
<ArrayOfProduct>
    <Product>...</Product>
    <Product>...</Product>
    <Product>...</Product>
    ...
</ArrayOfProduct>


ArrayOfProfile Array

Array Element
Element NameType
ProfileProfile
Xml Representation
<ArrayOfProfile>
    <Profile>...</Profile>
    <Profile>...</Profile>
    <Profile>...</Profile>
    ...
</ArrayOfProfile>


ArrayOfService Array

Array Element
Element NameType
ServiceService
Xml Representation
<ArrayOfService>
    <Service>...</Service>
    <Service>...</Service>
    <Service>...</Service>
    ...
</ArrayOfService>


ArrayOfShipment Array

Array Element
Element NameType
ShipmentShipment
Xml Representation
<ArrayOfShipment>
    <Shipment>...</Shipment>
    <Shipment>...</Shipment>
    <Shipment>...</Shipment>
    ...
</ArrayOfShipment>


ArrayOfShipmentActionResult Array

Array Element
Element NameType
ShipmentActionResultShipmentActionResult
Xml Representation
<ArrayOfShipmentActionResult>
    <ShipmentActionResult>...</ShipmentActionResult>
    <ShipmentActionResult>...</ShipmentActionResult>
    <ShipmentActionResult>...</ShipmentActionResult>
    ...
</ArrayOfShipmentActionResult>


ArrayOfShipmentDocumentsResult Array

Array Element
Element NameType
ShipmentDocumentsResultShipmentDocumentsResult
Xml Representation
<ArrayOfShipmentDocumentsResult>
    <ShipmentDocumentsResult>...</ShipmentDocumentsResult>
    <ShipmentDocumentsResult>...</ShipmentDocumentsResult>
    <ShipmentDocumentsResult>...</ShipmentDocumentsResult>
    ...
</ArrayOfShipmentDocumentsResult>


ArrayOfShipmentPackage Array

Array Element
Element NameType
ShipmentPackageShipmentPackage
Xml Representation
<ArrayOfShipmentPackage>
    <ShipmentPackage>...</ShipmentPackage>
    <ShipmentPackage>...</ShipmentPackage>
    <ShipmentPackage>...</ShipmentPackage>
    ...
</ArrayOfShipmentPackage>


ArrayOfShipmentPackageResult Array

Array Element
Element NameType
ShipmentPackageResultShipmentPackageResult
Xml Representation
<ArrayOfShipmentPackageResult>
    <ShipmentPackageResult>...</ShipmentPackageResult>
    <ShipmentPackageResult>...</ShipmentPackageResult>
    <ShipmentPackageResult>...</ShipmentPackageResult>
    ...
</ArrayOfShipmentPackageResult>


ArrayOfShipmentResult Array

Array Element
Element NameType
ShipmentResultShipmentResult
Xml Representation
<ArrayOfShipmentResult>
    <ShipmentResult>...</ShipmentResult>
    <ShipmentResult>...</ShipmentResult>
    <ShipmentResult>...</ShipmentResult>
    ...
</ArrayOfShipmentResult>


ArrayOfShipmentService Array

Array Element
Element NameType
ShipmentServiceShipmentService
Xml Representation
<ArrayOfShipmentService>
    <ShipmentService>...</ShipmentService>
    <ShipmentService>...</ShipmentService>
    <ShipmentService>...</ShipmentService>
    ...
</ArrayOfShipmentService>


ArrayOfShipmentStatusResult Array

Array Element
Element NameType
ShipmentStatusResultShipmentStatusResult
Xml Representation
<ArrayOfShipmentStatusResult>
    <ShipmentStatusResult>...</ShipmentStatusResult>
    <ShipmentStatusResult>...</ShipmentStatusResult>
    <ShipmentStatusResult>...</ShipmentStatusResult>
    ...
</ArrayOfShipmentStatusResult>


ArrayOfShipmentTrackingResult Array

Array Element
Element NameType
ShipmentTrackingResultShipmentTrackingResult
Xml Representation
<ArrayOfShipmentTrackingResult>
    <ShipmentTrackingResult>...</ShipmentTrackingResult>
    <ShipmentTrackingResult>...</ShipmentTrackingResult>
    <ShipmentTrackingResult>...</ShipmentTrackingResult>
    ...
</ArrayOfShipmentTrackingResult>


ArrayOfTrackingResult Array

Array Element
Element NameType
TrackingResultTrackingResult
Xml Representation
<ArrayOfTrackingResult>
    <TrackingResult>...</TrackingResult>
    <TrackingResult>...</TrackingResult>
    <TrackingResult>...</TrackingResult>
    ...
</ArrayOfTrackingResult>


CEP Type

Carrier Information.

Members
Member NameTypeRequiredMaxLengthDescription
CEPIDstringYes3Carrier abbreviation (UPS, PA1 for Parcel One, ...).
CEPLongnamestringNo30Carrier Longname.
DefaultintNo0 or 1Default Carrier information.
ProductsArrayOfProductNoProducts availabe for this carrier
Xml Representation
<CEP>
    <CEPID>...</CEPID>
    <CEPLongname>...</CEPLongname>
    <Default>...</Default>
    <Products>...</Products>
</CEP>


CEPSpecial Type

CEPSpecials Information.

Members
Member NameTypeRequiredMaxLengthDescription
KeystringNo20for DHL so far: Key: PRINTONLYIFCODEABLE, Value: 1 - will return label only in case LEITCODE could be found to avoid Surcharge for not codable addresses.
ValuestringNo20the needed value as string representation
Xml Representation
<CEPSpecial>
    <Key>...</Key>
    <Value>...</Value>
</CEPSpecial>


Charges Type

Charges Request Data.

Members
Member NameTypeRequiredMaxLengthDescription
CEPIDstringYes3Carrier abbreviation (UPS, PA1 for Parcel One, ...).
ConsignerIDstringYes20Consigner Abbreviation.
IDShipmentidentifyShipmentYesto identify Shipments to process.
MandatorIDstringYes20Mandator Abbreviation.
PackagesArrayOfShipmentPackageYesArray of Packages to calculate.
PrivateAddressIndicatorintNoPrivate Address = 1, B2B = 0
ProductIDstringYes20Product Abbreviation
ReturnShipmentIndicatorintNoReturn Shipment = 1; default = 0 = Forward Shipment
ServicesArrayOfShipmentServiceNoArray of Shipment Services of this shipment.
ShipToAddressAddressYesShipTo Data.
Xml Representation
<Charges>
    <CEPID>...</CEPID>
    <ConsignerID>...</ConsignerID>
    <IDShipment>...</IDShipment>
    <MandatorID>...</MandatorID>
    <Packages>...</Packages>
    <PrivateAddressIndicator>...</PrivateAddressIndicator>
    <ProductID>...</ProductID>
    <ReturnShipmentIndicator>...</ReturnShipmentIndicator>
    <Services>...</Services>
    <ShipToAddress>...</ShipToAddress>
</Charges>


ChargesPackageResult Type

Charges Parcel Results Data.

Members
Member NameTypeRequiredMaxLengthDescription
ChargesArrayOfAmountNoCharges for each package in shipments.
PackageIDstringNo20Package Identification.
PackageRefstringNo20Parcel Reference Field of Client.
ShipmentIDstringNo20Shipment ID.
TrackingIDstringNo20Tracking number
Xml Representation
<ChargesPackageResult>
    <Charges>...</Charges>
    <PackageID>...</PackageID>
    <PackageRef>...</PackageRef>
    <ShipmentID>...</ShipmentID>
    <TrackingID>...</TrackingID>
</ChargesPackageResult>


ChargesResult Type

Charges Result Data.

Members
Member NameTypeRequiredMaxLengthDescription
ActionResultShipmentActionResultNoSuccess, Errors and Shipment ID Fields.
PackageResultsArrayOfChargesPackageResultNoCharges on package level.
RemarksstringNoCharges Remarks.
ShipmentChargesArrayOfAmountNoCharges on shipment level.
TotalChargesAmountNoTotal Charges for Shipments.
Xml Representation
<ChargesResult>
    <ActionResult>...</ActionResult>
    <PackageResults>...</PackageResults>
    <Remarks>...</Remarks>
    <ShipmentCharges>...</ShipmentCharges>
    <TotalCharges>...</TotalCharges>
</ChargesResult>


ClosedResult Type

Closed Shipments Result Data.

Members
Member NameTypeRequiredMaxLengthDescription
CEPstringNo3Closed result for this carrier
ClosedStampstringNo20Stamp, consisting of DateTime (YYYYMMDDHHMMSS) and Carrier information, like 20150528135632PA1.
printDocumentResultprintDocumentsResultNoClosing Report as Base64-encoded string.
Xml Representation
<ClosedResult>
    <CEP>...</CEP>
    <ClosedStamp>...</ClosedStamp>
    <printDocumentResult>...</printDocumentResult>
</ClosedResult>


Consigner Type

Consigner Information.

Members
Member NameTypeRequiredMaxLengthDescription
ConsignerIDstringYes20Consigner Abbreviation.
DefaultintNo0 or 1Default Consigner (1=true).
ShortnamestringNo20Consigner Short name.
Xml Representation
<Consigner>
    <ConsignerID>...</ConsignerID>
    <Default>...</Default>
    <Shortname>...</Shortname>
</Consigner>


Contact Type

Contact Request Data.

Members
Member NameTypeRequiredMaxLengthDescription
AttentionNamestringNo50Attention name.
BirthDatestringNoDateBirth Date, not used yet.
CompanystringNo50Company Information.
ContactPersonstringNo50Contact Person
EmailstringNo40Email.
FaxstringNo40Fax.
FirstNamestringNo30Firstname.
LastNamestringNo30Lastname.
MobilestringNo40Mobile Phone Number.
PhonestringNo40Phone Number.
SalutationstringNo40not in use yet.
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 Type

Customer Info.

Members
Member NameTypeRequiredMaxLengthDescription
ConsignersArrayOfConsignerNoAvailable Consigners for this customer.
CustomerIDstringYes20Customer Number at Parcel.One .
DefaultintNo0 or 1Default Mandator (1=true).
MandatorIDstringNo20Mandator ID
ShortnamestringNo20Mandator Short name.
StatusstringNoID 0 = Customer active, ID 1 = Customer blocked, ID 2 = Customer anulled.
StatusIDintNoID 0 = Customer active, ID 1 = Customer blocked, ID 2 = Customer anulled.
Xml Representation
<Customer>
    <Consigners>...</Consigners>
    <CustomerID>...</CustomerID>
    <Default>...</Default>
    <MandatorID>...</MandatorID>
    <Shortname>...</Shortname>
    <Status>...</Status>
    <StatusID>...</StatusID>
</Customer>


Dimensions Type

Dimensions Information.

Members
Member NameTypeRequiredMaxLengthDescription
HeightstringNoDecimal (10,2).Height of Package, NumberFormat InvariantInfo.
LengthstringNoDecimal (10,2)Length of Package, NumberFormat InvariantInfo.
MeasurementstringNoMeasurement, so far only cm for centimeter.
WidthstringNoDecimal (10,2)Width of Package, NumberFormat InvariantInfo.
Xml Representation
<Dimensions>
    <Height>...</Height>
    <Length>...</Length>
    <Measurement>...</Measurement>
    <Width>...</Width>
</Dimensions>


Error Type

Error Identification.

Members
Member NameTypeRequiredMaxLengthDescription
ErrorNostringNoError No., usually 4 digits.
MessagestringNoError Message.
StatusCodestringNoError Type, usually Hard or Soft.
Xml Representation
<Error>
    <ErrorNo>...</ErrorNo>
    <Message>...</Message>
    <StatusCode>...</StatusCode>
</Error>


Format Type

Format Information.

Members
Member NameTypeRequiredMaxLengthDescription
HeightstringNoHeight for Print Document, not in use yet.
OrientationintNo0 or 10=Portrait, 1=Landscape, not in use yet.
SizestringNoPredefined size, like A4, A6, in use so far "CN22" for International Documents.
TypestringNo10Output format, like PDF or GIF.
UnitstringNoUnit of Height and Width parameter, not in use yet.
WidthstringNoOutput width, not in use yet.
Xml Representation
<Format>
    <Height>...</Height>
    <Orientation>...</Orientation>
    <Size>...</Size>
    <Type>...</Type>
    <Unit>...</Unit>
    <Width>...</Width>
</Format>


identifyPackage Type

Parcel Identification.

Members
Member NameTypeRequiredMaxLengthDescription
PackageRefFieldstringNooptional field of PackageReference, possible values: PackageID, PackageRef or PackageTrackingID.
PackageRefValuestringNoPackageRefValue to transfer value of this field. If empty, only Shipment is identified.
Xml Representation
<identifyPackage>
    <PackageRefField>...</PackageRefField>
    <PackageRefValue>...</PackageRefValue>
</identifyPackage>


identifyShipment Type

Shipment Identification.

Members
Member NameTypeRequiredMaxLengthDescription
ShipmentRefFieldstringNopossible values:ShipmentID, ShipmentRef or TrackingID.
ShipmentRefValuestringNoString representation of Value of this field.
Xml Representation
<identifyShipment>
    <ShipmentRefField>...</ShipmentRefField>
    <ShipmentRefValue>...</ShipmentRefValue>
</identifyShipment>


IntDoc Type

International Documents Request Data.

Members
Member NameTypeRequiredMaxLengthDescription
CertificateintNoo or 1Check Certificate Box on CN23, 1= true.
CertificateNostringNo25Certificate No to print on CN23.
CommentsstringNo100Comments to print on CN23.
ConsignerCustomsIDstringNo20Consigner's CustomsID to print on CN23, if not filled here, taken from Consigner Data in cbc-System.
ContentsDescArrayOfIntDocContentsNoContents lines for CN23.
CurrencystringNo33-character representation of Currency to use on CN23, default: EUR for Euro.
DatestringNoDateDate on CN23, if not filled today's date is used.
ExplanationstringNo100Explanation to be printed on CN23.
InternationalDocumentFormatFormatNoOutput Format may be GIF or PDF, Size will always be A4.
InvoiceintNo0 or 1Check Invoice box on CN23.
InvoiceNostringNo20Invoice No to print on CN23.
ItemCategoryintNo1,2,3,4,5 Item Category, possible values:1-Gift, 2-Documents, 3-Commercial Sample, 4-Returned Goods, 5-Other.
LicenseintNo0 or 1Check License Box on CN23.
LicenseNostringNo25License No to print on CN23.
NonDeliveryInstructionstringNonot in use yet, for future use.
OfficeOfOriginstringNo100Office of Origin to print on CN23.
PostagestringNoDecimal (10,2)Postage to include in CN23. NumberFormat: InvariantInfo
PrintInternationalDocumentsintNo0 or 1Print CN23 flag (1=true).
ServiceLevelstringNonot in use yet, for future use.
ShipToRefstringNo80ShipTo Reference on CN23, if not filled, Email and phone of ShipTo address will be used.
TotalValuestringNoDecimal (12,2)Total Value to print on CN23, if not filled, Total will be calculated (Contents values plus Postage). NumberFormat: InvariantInfo
TotalWeightkgstringNoDecimal (12,3)Total Weight in kg on CN23, if not filled, will be calculated from Contents Weights. NumberFormat: InvariantInfo
ValidatedForExportintNo0 or 1not in use yet, for future use (1=YES, 0=NO).
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>


IntDocContents Type

International Documents Contents Request Data.

Members
Member NameTypeRequiredMaxLengthDescription
ContentsstringNo60Contents Description.
ItemValuestringNoDecimal (12,2)ItemValue, NumberFormat: InvariantInfo.
NetWeightstringNoDecimal (12,3)NetWeight of Item, NumberFormat: InvariantInfo.
OriginstringNo40if possible, Alpha-2-code Country abbreviation (ISO 3166-1).
QuantityintNoIntQuantity of Item.
TariffNumberstringNo30TariffNumber of Item.
Xml Representation
<IntDocContents>
    <Contents>...</Contents>
    <ItemValue>...</ItemValue>
    <NetWeight>...</NetWeight>
    <Origin>...</Origin>
    <Quantity>...</Quantity>
    <TariffNumber>...</TariffNumber>
</IntDocContents>


IntDocData Type

International Documents Request Data.

Members
Member NameTypeRequiredMaxLengthDescription
IDPackageidentifyPackageNoto identify Package, if not filled, only Shipment will be identified.
IDShipmentidentifyShipmentYesto identify Shipments to process.
InternationalDocIntDocNoInternational Documents Data to add to Shipments/Packages.
Xml Representation
<IntDocData>
    <IDPackage>...</IDPackage>
    <IDShipment>...</IDShipment>
    <InternationalDoc>...</InternationalDoc>
</IntDocData>


Measurement Type

Measurements Information.

Members
Member NameTypeRequiredMaxLengthDescription
UnitstringNocan be different
ValuestringNoDecimalValue of Measurement. NumberFormat: InvariantInfo.
Xml Representation
<Measurement>
    <Unit>...</Unit>
    <Value>...</Value>
</Measurement>


printDocumentsResult Type

Shipment Documents Print Result Data.

Members
Member NameTypeRequiredMaxLengthDescription
ActionResultShipmentActionResultNoSuccess, Errors and Shipment ID Fields.
DocTypestringNo25Description of Document returned.
DocumentstringNoDocument as Base64-encoded string.
FormatFormatNoto identify returned Format of Document.
PackageIDstringNo20Parcel No.
PackageRefstringNo20Parcel Reference Field of Client.
PackageTrackingIDstringNo20Parcel Tracking Number.
Xml Representation
<printDocumentsResult>
    <ActionResult>...</ActionResult>
    <DocType>...</DocType>
    <Document>...</Document>
    <Format>...</Format>
    <PackageID>...</PackageID>
    <PackageRef>...</PackageRef>
    <PackageTrackingID>...</PackageTrackingID>
</printDocumentsResult>


PrintRequest Type

Print Request Data.

Members
Member NameTypeRequiredMaxLengthDescription
DocTypestringNo25Identification of Document, not required yet.
FormatFormatNoto define Format to return, possible values, dependent on requested document: PDF or GIF.
IDPackageidentifyPackageNoto identify Parcel, if not filled, only Shipment is identified.
IDShipmentidentifyShipmentNoto identify Shipment to process.
Xml Representation
<PrintRequest>
    <DocType>...</DocType>
    <Format>...</Format>
    <IDPackage>...</IDPackage>
    <IDShipment>...</IDShipment>
</PrintRequest>


Product Type

Product Information.

Members
Member NameTypeRequiredMaxLengthDescription
DefaultintNo0 or 1Default Product for Carrier - (1=true).
ProductIDstringNo20Product abbreviation, e.g. 11 for UPS-Standard, eco for PA1-Eco.
ProductNamestringNo20Product Name.
ServicesArrayOfServiceNoAvailable services for this carrier/product-combination.
Xml Representation
<Product>
    <Default>...</Default>
    <ProductID>...</ProductID>
    <ProductName>...</ProductName>
    <Services>...</Services>
</Product>


Profile Type

Profile for a mandator.

Members
Member NameTypeRequiredMaxLengthDescription
CEPsArrayOfCEPNoAvailable CEPs.
ConsignersArrayOfConsignerNoavailable Consigners for this Mandator.
DefaultintNo0 or 1Default Mandator (1=true).
MandatorIDstringNo20Mandator ID.
MandatorShortnamestringNo20Mandator Short name.
Xml Representation
<Profile>
    <CEPs>...</CEPs>
    <Consigners>...</Consigners>
    <Default>...</Default>
    <MandatorID>...</MandatorID>
    <MandatorShortname>...</MandatorShortname>
</Profile>


Service Type

Services Information.

Members
Member NameTypeRequiredMaxLengthDescription
AmountNeededintNo0 or 1Amout spec required (1=true) for this service, e.g. for COD or Insurance.
CurrencyNeededintNo0 or 1Currency required (1=true) for this service, 3-character-Abbreviaton of Currency, e.g. EUR for Euro..
DefaultintNo0 or 1 or 20=Optional (Service may be booked), 1=Standard (Service may be shown as a default choice), 2=Forced (Service will be added by the API anyway if not chosen already)
ServiceIDstringNo10Service ID, e.g. NN for COD, SA for SaturdayDelivery, depends on available Services for Carrier.
ServiceNamestringNo30Service Description, language-sensitive.
Xml Representation
<Service>
    <AmountNeeded>...</AmountNeeded>
    <CurrencyNeeded>...</CurrencyNeeded>
    <Default>...</Default>
    <ServiceID>...</ServiceID>
    <ServiceName>...</ServiceName>
</Service>


ShipFrom Type

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

Members
Member NameTypeRequiredMaxLengthDescription
CustomsIDstringNo20Consigner's customsID.
Name1stringNo50First line on Shipment label.
Name2stringNo502nd line on shipment label.
Name3stringNo503rd line on shipment label
ReferencestringNo20ShipFrom Reference by Client.
SalesTaxIDstringNo20Sales TaxID of Consigner,not in use yet.
ShipmentAddressAddressNoShipFrom Address.
ShipmentContactContactNoShipFrom Contact Data, information like phone and/or email required for some carriers.
Xml Representation
<ShipFrom>
    <CustomsID>...</CustomsID>
    <Name1>...</Name1>
    <Name2>...</Name2>
    <Name3>...</Name3>
    <Reference>...</Reference>
    <SalesTaxID>...</SalesTaxID>
    <ShipmentAddress>...</ShipmentAddress>
    <ShipmentContact>...</ShipmentContact>
</ShipFrom>


Shipment Type

Shipment Request Data.

Members
Member NameTypeRequiredMaxLengthDescription
CEPIDstringYes20Carrier Abbreviation, e.g. UPS or PA1 for Parcel One.
CEPSpecialsArrayOfCEPSpecialNo 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.
ConsignerIDstringYes20to identify Consigner to ship from.
CostCenterstringNo20for client use.
DocumentFormatFormatNospecify Format for Documents to be returned, e.g. UPS HighValueReport, only value possible: PDF.
LabelFormatFormatNoLabel Format, only possible values of Type: GIF or PDF, Size-Parameter is not used yet.
MandatorIDstringYes20Mandator ID for shipment.
MaxChargesAmountNo You can specify an amount of Charge as a maximum for the shipment (Amount of Zero = no action). In case of exaggerating the shipment will be declined with an error message. (So far charges are only returned for UPS.)
Other1stringNo30Additional Information of any kind.
Other2stringNo30Additional Information of any kind.
Other3stringNo30Additional Information of any kind.
PackagesArrayOfShipmentPackageYesParcel Specifications.
PrintDocumentsintNo0 or 1.Return Documents, like UPS HighValueReport, with Shipment? Default=0=false.
PrintLabelintNo0 or 1Return Label with shipment, default=0=false.
ProductIDstringYes20Product for Carrier, e.g. 11 for UPS Standard, eco for Parcel One-eco.
ReturnChargesintNo0 or 1to return the shipment charges (so far only works for UPS), default=0=false, 1 = true.
ReturnShipmentIndicatorintNo0 or intvalue. 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.
ServicesArrayOfShipmentServiceNoServices for Shipment.
ShipFromDataShipFromNoShipFrom-Data, to use only with special agreement with Parcel.One , usually ConsignerID is used.
ShipToDataShipToYesShipTo-Data.
ShipmentIDstringNonumeric (int64)if shipping successfull, ShipmentID will be overwritten/assigned, has to be numeric.
ShipmentRefstringNo20Shipment Client reference, for later identification.
SoftwarestringYes20Software and version used.
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>


ShipmentActionResult Type

Shipment Action Results.

Members
Member NameTypeRequiredMaxLengthDescription
ErrorsArrayOfErrorNoArray of Error Information.
ShipmentIDstringNoint64ShipmentID assigned with succesfull shippings.
ShipmentRefstringNo20Shipment Reference field provided by client for identification.
SuccessintNo-1,0,1-1=Error, 0=Warnings, 1=Successfull.
TrackingIDstringNo20Tracking ID provided by carrier.
Xml Representation
<ShipmentActionResult>
    <Errors>...</Errors>
    <ShipmentID>...</ShipmentID>
    <ShipmentRef>...</ShipmentRef>
    <Success>...</Success>
    <TrackingID>...</TrackingID>
</ShipmentActionResult>


ShipmentDocumentsResult Type

Shipment Documents Results Data.

Members
Member NameTypeRequiredMaxLengthDescription
ChargesArrayOfAmountNonot in use yet.
DocTypestringNo25DocumentType for description of document returned.
DocumentstringNoDocument returned as Base64-encoded string.
FormatFormatNoto return provided DocumentType (PDF,GIF), DocumentSize (A4,A6), etc.
PackageIDstringNo20Parcel ID assigned at Shipping.
ShipmentIDstringNoInt64ShipmentID assigned at Shipping.
TrackingIDstringNo20TrackingID assigned by Carrier at Shipping.
Xml Representation
<ShipmentDocumentsResult>
    <Charges>...</Charges>
    <DocType>...</DocType>
    <Document>...</Document>
    <Format>...</Format>
    <PackageID>...</PackageID>
    <ShipmentID>...</ShipmentID>
    <TrackingID>...</TrackingID>
</ShipmentDocumentsResult>


ShipmentPackage Type

Parcel Information.

Members
Member NameTypeRequiredMaxLengthDescription
IntDocDataIntDocNoInternational Documents Data for Parcel (for Shipment send with first parcel).
PackageDimensionsDimensionsNoto specify Length, Width, Height, required for some carriers.
PackageIDstringNo20will be reassigned at successfull shipping.
PackageRefstringNo20Client's reference to parcel.
PackageTypestringNo10Letter, Parcel, ... - required for UPS - UPS: Package Type = "02" for "Package".
PackageVolumeMeasurementNoVolume for Parcel in liters, required for some carriers.
PackageWeightMeasurementNoParcelWeight in kg, required for most carriers.
RemarksstringNo100Client's comments.
ServicesArrayOfShipmentServiceNoSpecify Services at package level.
Xml Representation
<ShipmentPackage>
    <IntDocData>...</IntDocData>
    <PackageDimensions>...</PackageDimensions>
    <PackageID>...</PackageID>
    <PackageRef>...</PackageRef>
    <PackageType>...</PackageType>
    <PackageVolume>...</PackageVolume>
    <PackageWeight>...</PackageWeight>
    <Remarks>...</Remarks>
    <Services>...</Services>
</ShipmentPackage>


ShipmentPackageResult Type

Shipment Parcel Results Data.

Members
Member NameTypeRequiredMaxLengthDescription
ChargesArrayOfAmountNonot in use yet.
DocTypestringNo25will always be "Label".
FormatFormatNoto return provided Format (Type=GIF or PDF, Size=A4 or A6).
LabelstringNo64base-encoded string of Label.
PackageIDstringNo20Parcel number assigned at successfull shipping.
PackageRefstringNo20Parcel reference provided by client for identification.
ShipmentIDstringNoint64Shipment ID assigned at succesfull shipping.
TrackingIDstringNo20Tracking ID provided by carrier at successfull shipping.
TrackingURLstringNo120TrackingURL of respective Carrier.
Xml Representation
<ShipmentPackageResult>
    <Charges>...</Charges>
    <DocType>...</DocType>
    <Format>...</Format>
    <Label>...</Label>
    <PackageID>...</PackageID>
    <PackageRef>...</PackageRef>
    <ShipmentID>...</ShipmentID>
    <TrackingID>...</TrackingID>
</ShipmentPackageResult>


ShipmentResult Type

Shipment Results Data.

Members
Member NameTypeRequiredMaxLengthDescription
ActionResultShipmentActionResultNoShipment Identification fields, Errors, Success.
ChargesArrayOfAmountNoCharges Information if ReturnCharges has been selected.
DocumentsAvailableintNoNumber of available Documents for this shipment.
DocumentsResultsArrayOfShipmentDocumentsResultNoDocuments returned if specified, e.g. UPS HighValueReport.
InternationalDocumentsAvailableintNoNumber of International Documents available for this shipment.
InternationalDocumentsNeededintNo1Values: -1 = has not been checked (with Parcel.One will be always checked), 0 = not required, 1= required. This information is returned independently of whether InternationalDocuments-Data have been provided or not!
InternationalDocumentsResultsArrayOfShipmentDocumentsResultNoCN23 returned if specified.
LabelsAvailableintNoNumber of labels available for this shipment.
LabelURLstringNo200LabelURL, so far only used for UPS Return Shipments with ReturnShipmentIndicator "8".
PackageResultsArrayOfShipmentPackageResultNoParcel data returned.
TotalChargesAmountNoTotal Charges Information if ReturnCharges has been selected.
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>


ShipmentService Type

Services Information.

Members
Member NameTypeRequiredMaxLengthDescription
ParametersstringNo100not in use yet.
ServiceIDstringNo20Service Abbreviation, depending on Carrier/Product, e.g. NN for COD, SA for SaturdayDelivery.
ValueAmountNoAmount and Currency required for some Services like COD and Insurance.
Xml Representation
<ShipmentService>
    <Parameters>...</Parameters>
    <ServiceID>...</ServiceID>
    <Value>...</Value>
</ShipmentService>


ShipmentStatusResult Type

Shipment Status Results.

Members
Member NameTypeRequiredMaxLengthDescription
ActionResultShipmentActionResultNoShipment Identification fields, Erros, Success.
ShipmentStatusstringNo20Shipment Status, Code 10 = Shipped; Code 90 = Closed, Status will be returned according to client language provided.
ShipmentStatusCodestringNoCode 10 = Shipped; Code 90 = Closed, Status will be returned according to client language provided.
LastTrackingNostringNoTracking Code (often USPS-No.) of last known Carrier nearest to destination carrier.
LastCEPstringNoLast known Carrier nearest to destination carrier..
Xml Representation
<ShipmentStatusResult>
    <ActionResult>...</ActionResult>
    <ShipmentStatus>...</ShipmentStatus>
    <ShipmentStatusCode>...</ShipmentStatusCode>
    <LastTrackingNo>...</LastTrackingNo>
    <LastCEP>...</LastCEP>
</ShipmentStatusResult>


ShipmentTrackingResult Type

Shipment Trackings Results.

Members
Member NameTypeRequiredMaxLengthDescription
ActionResultShipmentActionResultNoShipment Identification fields, Erros, Success.
TrackingsArrayOfTrackingResultNoArray of Tracking Data (DateTime, StatusCode, Status) for every Shipment inquired.
Xml Representation
<ShipmentTrackingResult>
    <ActionResult>...</ActionResult>
    <Trackings>...</Trackings>
</ShipmentTrackingResult>


ShipTo Type

Shipto / Receiver Data.

Members
Member NameTypeRequiredMaxLengthDescription
BranchIDstringNo20Branch or Pickup ID of Carrier. Not in use yet.
CEPCustIDstringNo20Carrier Customer ID of Receiver, e.g. UPS Customer No. for cheaper Shipping. Not in use yet.
CustomsIDstringNo20Receiver's customsID.
Name1stringYes50First line on shipment label.
Name2stringNo502nd line on shipment label.
Name3stringNo503rd line of shipment label.
PrivateAddressIndicatorintYes0 or 1Private Address of Receiver? (1=true) - B2B or B2C.
ReferencestringNo20ShipTo Reference provided by client.
SalesTaxIDstringNo20Sales TaxID of Receiver, not in use yet.
ShipmentAddressAddressYesShipTo Address.
ShipmentContactContactNoShipTo Contact Data, information like phone and/or email required for some carriers.
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>


TrackingResult Type

Shipment Tracking Result Data.

Members
Member NameTypeRequiredMaxLengthDescription
TrackingDateTimestringNoTracking Event DateTime.
TrackingStatusstringNoChar unlimitedTracking Event Status Description.
TrackingStatusCodestringNo20Tracking Event Status Code Number.
Xml Representation
<TrackingResult>
    <TrackingDateTime>...</TrackingDateTime>
    <TrackingStatus>...</TrackingStatus>
    <TrackingStatusCode>...</TrackingStatusCode>
</TrackingResult>


ArrayOfstring Array

Array Element
Element NameType
stringstring
Xml Representation
<ArrayOfstring>
    <string>...</string>
    <string>...</string>
    <string>...</string>
    ...
</ArrayOfstring>
PARCEL.ONE Logo

PARCEL.ONE GmbH
Otto-Hahn-Straße 21
35510 Butzbach
Germany

+49 6033 352250
info@parcel.one

  • NET & WORK am 16.02.2019 in Frankfurt

  • Ecommerce EXPO am 20.02.2019 in Berlin

  • plentymarkets am 15.03. - 16.03.2019  in Kassel

  • InternetWorld am 12.03. - 13.03.2019 in München