Schenker Privpak AB Telefon VAT Nr. SE Schenker ABs ansvarsbestämmelser, identiska med Box 905 Faxnr Säte: Borås

Transkript

1 Schenker Privpak AB Interface documentation for web service packageservices.asmx Version: Doc. no.: I04304b

2 Sida 2 av 7 Revision history Datum Version Sign. Kommentar TE First public version that only includes SearchCollectionPoint.

3 Sida 3 av 7 Index Revision history General information Getting started Authentication Method: SearchCollectionPoint Information Request Response Error handling Miscellaneous Method: GetCollectionPointInfo Information Request Response Error handling Appendix Consignment Product ID Return Product ID... 7

4 Sida 4 av 7 1. General information 1.1. Getting started The web service is located at the URL below: Authentication To use the methods SearchCollectionPoint and GetCollectionPointInfo a registration is required. Registration form is located at the URL below: The reason that the registration requires an address is so that we can communicate updates made to our web services. To gain access to the other methods in this web service, you must first have an account set up. Your contact at the Schenker Privpak AB sales department can help you to set one up.

5 Sida 5 av 7 2. Method: SearchCollectionPoint 2.1. Information Returns a list of nearby (based on post code or city) collection points. To choose one automatically, enter the consumer s post code and then use the first item of the list. This results in a collection point with a minimal distance to the consumer Request Name Type Required Description CustomerID Int Yes Product Ombud Ekonomi Sweden: Customer ID 1 = (if you don t have a CustomerId) Product Ombud Standard Sweden: 10070= always Key String Yes (1) Registration key ServiceID String No Default value = (blank) ParamID Int Yes Product Ombud Ekonomi Sweden: 0= with subcontractor(default) 1= without subcontractor Product Ombud Standard Sweden: 1=Ombud Standard with subcontractors Address String No Street address Postcode String Yes (2) Post code City String Yes (2) City Maxhits Int Yes Default value = 0 (gives max hits) Use to limit the number of hits displayed. 1: To obtain a key, see chapter : Either postcode or city is required 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 Post 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)

6 Sida 6 av 7 ConsignmentProductID ReturnProductID Required parameter for consignments via EDI files. Also to be used with future method Consignment (currently not implemented) See chapter 4.1 Required input parameter for methods ConsignmentReturn and Return. See Error handling We return an item with CpointID = -1 if an exception occurs, for example when no match is found. Error message is in that case sent in the field DisplayName Miscellaneous Searching by street address is not yet implemented. We may add this in a future release. 3. Method: GetCollectionPointInfo 3.1. Information This method returns information for a certain collection point Request Name Type Required Description CustomerID Int Yes Your customer ID in our system. If you do not have a customer ID, set to 1 for Sweden or 2 for Norway 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 Response See chapter Error handling See chapter 2.4.

7 Sida 7 av 7 4. Appendix 4.1. Consignment Product ID ProductID Description Note 1000 Consignment Schenker Privpak Used in EDI files only 1010 Consignment Posten Norden (Sweden) Not yet implemented 1030 Consignment Itella/Posten Finland (Finland) Not yet implemented 4.2. Return Product ID ProductID Description Note 2000 Return Schenker Privpak 2010 Return Posten Norden (Sweden) 2030 Return Itella/ Posten Finland (Finland)