Schenker Privpak AB
Interface documentation
Web service – package_1.3
Schenker Privpak AB Street address: Ryssnäsgatan 15 VAT No: SE556124398001 The General Conditions of the Nordic Association of Freight Forwarders (NSAB 2000) Box 905 Phone: +46 (0)33-178300 Site: Borås applies to all agreements and assignments for Transport, Freight Forwarding, 504 64 Borås Fax: +46 (0)33-257475 Warehousing or other Logistic Services entered into or performed by DB Schenker
1 General information ... 1 1.1 Getting started ...1 1.2 Authentication ...1 2 Method – SearchCollectionPoint ... 2 2.1 Information ...2 2.2 Request ...2 2.3 Response ...2 2.4 Error handling ...3 2.5 Terminal mode ...3 2.6 Miscellaneous ...3 3 Method – GetCollectionPointInfo ... 3 3.1 Information ...3 3.2 Request ...3 3.3 Response ...3 3.4 Error handling ...3 4 Appendix ... 4 4.1 Consignment Product ID ...4 4.2 Return Product ID ...4
Page 1 of
1
General information
This document describes the two web service methods SearchCollectionPoint and
GetCollectionPointInfo. The document is developed for customers who wish to provide their customers with information about Schenker Privpak’s collection points and/or the opportunity to choose between collection points when purchasing.
1.1
Getting started
The web service is located at the following URL:
http://privpakservices.schenker.nu/package/package_1.3/packageservices.asmx
1.2
Authentication
To use the methods, a registration is required. The registration form is located at the following URL:
http://privpakservices.schenker.nu/package/package_1.3/register.aspx
Note that the registration requires an email address. The reason for this is that it enables communication of future updates and modifications made to the web services.
To access the other methods in the web service, you must first have an account set up for you. Please contact your representative at Schenker Privpak’s sales/integration department or send an e-mail to [email protected] if you need help with this.
Schenker Privpak AB Street address: Ryssnäsgatan 15 VAT No: SE556124398001 The General Conditions of the Nordic Association of Freight Forwarders (NSAB 2000) Box 905 Phone: +46 (0)33-178300 Site: Borås applies to all agreements and assignments for Transport, Freight Forwarding, 504 64 Borås Fax: +46 (0)33-257475 Warehousing or other Logistic Services entered into or performed by DB Schenker
2
Method – SearchCollectionPoint
2.1
Information
Returns a list of nearby (based on a postal code or city) collection points. To choose a collection point automatically, enter the consumer’s postal code and then use the first item of the list. This will return the collection point with the least distance to the consumer.
2.2
Request
Name Type Required Description
CustomerID Integer Yes Your customer ID in our system. If you do not have a customer ID, set to 1 for Sweden, 3 for Finland or 10070 for the product “Ombud Standard” (Sweden)
Key String Yes (1*) Registration key
ServiceID String No Default value = “ ” (blank)
ParamID Integer Yes
Product “Ombud Ekonomi” (Sweden/Finland):
0 (default) = with subcontractors, 1 = without subcontractors Product “Ombud Standard” (Sweden):
1 = Ombud Standard with subcontractors
Address String No Street address
Postcode String Yes (2*) Postal code
City String Yes (2*) City
Maxhits Integer Yes Limits the number of hits displayed. Default value: 0 (the internal limit in the system) 1*: To obtain a key, see chapter 1.2
2*: Either postal code or city is required.
2.3
Response
Name Description
CpointID Id of collection point
DisplayName Name of collection point
Distance Distance to collection point
AddressLine1 Address of collection point AddressLine2 Address of collection point
PostCode Postal code of collection point
City City of collection point
CountryCode Country code
OpenHours Open hours
OpenHours1 Open hours detail row 1
OpenHours2 Open hours detail row 2
OpenHours3 Open hours detail row 3
Directions Additional directions to the collection point CardAvailable Bank/credit card available
CardName Bank/credit card information
CardInfo Bank/credit card additional information
Latitude Coordinate in Decimal Degrees (WGS84)
Longitude Coordinate in Decimal Degrees (WGS84)
ConsignmentProductID Required parameter for consignments via EDI files. Also to be used with future method Consignment (currently not implemented) See chapter 4.1 ReturnProductID Required input parameter for methods See chapter 4.2. ConsignmentReturn and Return.
Page 3 of
2.4
Error handling
An item with CpointID = -1 is returned if an exception occurs, e.g. when no match is found. Eventual error messages are sent in the field DisplayName.
2.5
Terminal mode
It is possible to use the web service method to search for DB Schenker Terminal Service Points. To enable Terminal search mode you need to pass in “ParamID = 4” when making the request. Note that your customerID also needs to be configured for this feature in Schenker Privpak’s system. If you need help with this, please contact [email protected].
2.6
Miscellaneous
Searching by street address is not yet implemented. This feature may be added in a future release.
3
Method – GetCollectionPointInfo
3.1
Information
The method returns information about a specific collection point.
3.2
Request
Name Type Required Description
CustomerID Integer Yes Your customer ID in the system. If you do not have a customer ID, set to 1 for Sweden or 3 for Finland Key String Yes (1*) Registration key
ServiceID String No Default value: “” (blank) CpointID String Yes Collection point ID 1*: To obtain a key, see chapter 1.2
3.3
Response
See chapter 2.3.
3.4
Error handling
Schenker Privpak AB Street address: Ryssnäsgatan 15 VAT No: SE556124398001 The General Conditions of the Nordic Association of Freight Forwarders (NSAB 2000) Box 905 Phone: +46 (0)33-178300 Site: Borås applies to all agreements and assignments for Transport, Freight Forwarding, 504 64 Borås Fax: +46 (0)33-257475 Warehousing or other Logistic Services entered into or performed by DB Schenker
4
Appendix
4.1
Consignment Product ID
ProductID Description Note
1000 Consignment Schenker Privpak Used in EDI files only
1010 Consignment Posten Norden (Sweden) Currently not implemented 1030 Consignment Itella/Posten Finland (Finland) Used in EDI files only
4.2
Return Product ID
ProductID Description Note
2000 Return Schenker Privpak 2010 Return Posten Norden (Sweden) 2030 Return Itella/ Posten Finland (Finland)
