ServiceObject
Click here for a complete list of operations.
GetAvailableServices
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST / HTTP/1.1 Host: test-api.nfk.inpost.pl Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://tempuri.org/GetAvailableServices" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetAvailableServices xmlns="http://tempuri.org/"> <token> <UserName>string</UserName> <Password>string</Password> </token> <getAvailableServicesRequest> <ReadyDate>dateTime</ReadyDate> <ShipFrom> <PointId>string</PointId> <Name>string</Name> <Address>string</Address> <City>string</City> <PostCode>string</PostCode> <CountryCode>string</CountryCode> <Person>string</Person> <Contact>string</Contact> <Email>string</Email> <IsPrivatePerson>boolean</IsPrivatePerson> </ShipFrom> <ShipTo> <PointId>string</PointId> <Name>string</Name> <Address>string</Address> <City>string</City> <PostCode>string</PostCode> <CountryCode>string</CountryCode> <Person>string</Person> <Contact>string</Contact> <Email>string</Email> <IsPrivatePerson>boolean</IsPrivatePerson> </ShipTo> <Parcels> <Parcel> <Type>Envelope or Package or Palette</Type> <Weight>decimal</Weight> <D>decimal</D> <W>decimal</W> <S>decimal</S> <IsNST>boolean</IsNST> <ParcelExternalParam>string</ParcelExternalParam> </Parcel> <Parcel> <Type>Envelope or Package or Palette</Type> <Weight>decimal</Weight> <D>decimal</D> <W>decimal</W> <S>decimal</S> <IsNST>boolean</IsNST> <ParcelExternalParam>string</ParcelExternalParam> </Parcel> </Parcels> <COD> <Amount>decimal</Amount> <RetAccountNo>decimal</RetAccountNo> </COD> <InsuranceAmount>decimal</InsuranceAmount> <AdditionalServices> <AdditionalService> <Code>string</Code> </AdditionalService> <AdditionalService> <Code>string</Code> </AdditionalService> </AdditionalServices> </getAvailableServicesRequest> </GetAvailableServices> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetAvailableServicesResponse xmlns="http://tempuri.org/"> <GetAvailableServicesResult> <AvailableServices> <Service> <ID>int</ID> <Name>string</Name> </Service> <Service> <ID>int</ID> <Name>string</Name> </Service> </AvailableServices> </GetAvailableServicesResult> </GetAvailableServicesResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST / HTTP/1.1 Host: test-api.nfk.inpost.pl Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetAvailableServices xmlns="http://tempuri.org/"> <token> <UserName>string</UserName> <Password>string</Password> </token> <getAvailableServicesRequest> <ReadyDate>dateTime</ReadyDate> <ShipFrom> <PointId>string</PointId> <Name>string</Name> <Address>string</Address> <City>string</City> <PostCode>string</PostCode> <CountryCode>string</CountryCode> <Person>string</Person> <Contact>string</Contact> <Email>string</Email> <IsPrivatePerson>boolean</IsPrivatePerson> </ShipFrom> <ShipTo> <PointId>string</PointId> <Name>string</Name> <Address>string</Address> <City>string</City> <PostCode>string</PostCode> <CountryCode>string</CountryCode> <Person>string</Person> <Contact>string</Contact> <Email>string</Email> <IsPrivatePerson>boolean</IsPrivatePerson> </ShipTo> <Parcels> <Parcel> <Type>Envelope or Package or Palette</Type> <Weight>decimal</Weight> <D>decimal</D> <W>decimal</W> <S>decimal</S> <IsNST>boolean</IsNST> <ParcelExternalParam>string</ParcelExternalParam> </Parcel> <Parcel> <Type>Envelope or Package or Palette</Type> <Weight>decimal</Weight> <D>decimal</D> <W>decimal</W> <S>decimal</S> <IsNST>boolean</IsNST> <ParcelExternalParam>string</ParcelExternalParam> </Parcel> </Parcels> <COD> <Amount>decimal</Amount> <RetAccountNo>decimal</RetAccountNo> </COD> <InsuranceAmount>decimal</InsuranceAmount> <AdditionalServices> <AdditionalService> <Code>string</Code> </AdditionalService> <AdditionalService> <Code>string</Code> </AdditionalService> </AdditionalServices> </getAvailableServicesRequest> </GetAvailableServices> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetAvailableServicesResponse xmlns="http://tempuri.org/"> <GetAvailableServicesResult> <AvailableServices> <Service> <ID>int</ID> <Name>string</Name> </Service> <Service> <ID>int</ID> <Name>string</Name> </Service> </AvailableServices> </GetAvailableServicesResult> </GetAvailableServicesResponse> </soap12:Body> </soap12:Envelope>