SOAP API Reference
This article introduces you to Paazl's SOAP API, and provides links to more detailed articles.
Note
- We advise you to use the PHP 5 SOAP client
- While integrating the Paazl platform of products and services with a third-party system, we strongly recommend that you follow defensive programming best practices
Authentication
Each request to Paazl's SOAP web service is an XML/SOAP message submitted using HTTP. All requests require authentication, meaning that a valid token must be sent with a request in order to authorize the requester to access Paazl resources.
Read Soap authentication for more information.
WSDL files
Staging
The WSDL URL for your Paazl staging (= acceptance testing) account is:
https://staging.paazl.com/parcelshipperservice/orderRequest.wsdl
Production
The WSDL URL for your Paazl production account is:
https://ost.paazl.com/parcelshipperservice/orderRequest.wsdl
SOAP API call overview
The following calls are available.
- addExistingShipment
- address
- cancelShipments
- changeOrder
- checkout
- checkoutStatus
- commitOrder
- createPickup
- createStores
- deleteOrder
- deleteStores
- deliveryEstimate
- generateExtraPdfLabel
- generateLabels
- generatePdfLabels
- generatePdfReturnLabels
- generateShippingManifest
- generateZplLabels
- getExistingPdfLabel
- getExistingPdfLabels
- listOrders
- listStores
- openBatch
- order
- orderDetails
- orderStatus
- rate
- servicePoints
- shippingOption
- updateOrder
- updateStores
Status and error codes
To each request the API returns a response. The response differs per request. In case of an error, an error-response will be returned. In each case the structure will be identical and at least contains an error code and a description of the error (see Error Responses).