Developer Support

Our Data APIs are very stable & tested - some of them having been in use for over a decade & having processed millions of requests. The Store API less so - being currently in beta.

However sometimes when you just can't get things to work it helps having someone to call on & our team can help in that regard.

What to do when it doesn't work

Access to the Zeald API is provided to approved 3rd parties who are looking to use the Zeald API to develop integrated solutions on behalf of Zeald clients. We currently offer limited "fair use" email support for free. If you are requiring more comprehensive assistance, we are happy to provide paid developer support and consulting as required.

We would ask that you help us, by reading this document carefully before emailing us.

Golden Rule: Please don't email us until you have read the documentation contained in this wiki and submitted an actual XML request

While we endeavour to respond as quickly as possible, if are experience heavy workload it can sometimes take us a few days. More responsive support is available on a paid basis.

Submitting a request

Please provide the following information with every support request:

  • Is this an actual suspected bug with the API, or do you simply require assistance?
  • The endpoint you are accessing.
  • The HTTP method you are using (eg GET, POST, PUT or DELETE).
  • The XML you sent. Ideally send it to us in an attached file in an email. If your issue is with the XML response, send us that too.
  • What went wrong? Please provide as much detail as possible, ie. affected order numbers, SKUs, usernames - whatever can help us identify the underlying object(s) with which there is an issue.
  • If it seems to be intermittent the date/time it last failed, so we can analyse logs.

Send your request to api@zeald.com and our team will be in touch.

Additional support

If you require more comprehensive support, our developers know the technology inside & out and are available to consult and assist on a paid basis. Please get in touch & we can discuss this further.

Debugging

Often we get support requests and find the API is working fine - the problem relating to the http client being used. The first thing we do is use the information you provide to attempt to reproduce the problem by posting the XML using curl.

If you suspect that your HTTP client tools may be at fault, you can save time by trying this yourself by running the following command:

curl -k -X POST -H "Content-type: text/xml" -d @- https://<your api key>:@<your url> < data.xml

Alternatively try to execute the call using Postman.