Developer Programs

Learn

Docs
Important Notice. JH Datacenter Change announced

API Version

API Version

Symitar NO LONGER creates a new API version every release .

ALL DEVELOPERS MUST use the latest “PERSISTENT” version for new development.

SymXchange Versioning

When we update the SymXchange web service interface, existing SymXchange clients are affected. We use web services versioning to deploy the changes that affect clients so that clients have time to adapt to changes. There are two types of changes to the web service:

  • Backward Compatible

    • Adding new operations to SymXchange.
    • Adding new XML schema types that are not contained within previously existing types.
    • Adding optional elements or attributes to existing request messages.
    • Adding new optional elements (fields) to the end of an existing database entity element in the response. For the changes that are backward compatible, the SymXchange client does not have to do any code change.
  • Not Backward Compatible

    • Removing an operation.
    • Renaming an operation.
    • Changing the parameters (in data type or order) of an operation.
    • Changing the structure of a complex data type.
    • Adding new required elements to existing messages.
    • Removing required elements.

To handle the changes that are not backward compatible, the SymXchange client must make code changes, which makes it a breaking change (see SymXchange Code Changes).

For the changes that are backward compatible, the SymXchange consumer does not have to make any changes to the code. There are NO LONGER separate URLS for the different versions.


Did this page help you?

Last updated Mon Jun 8 2026