Endpoint Deprecation

In the continuous evolution of our SaaS solution, we perform a review/update of our API every six months. This review results in some endpoints, attributes, or operations being deprecated/removed.

The deprecations for API v4 and API v5 endpoints are announced six months in advance of their removal date to give you time to verify that you're not impacted by them or to migrate your code accordingly.

🚧

Announcements and deprecations take place on October 15th and April 15th every year.

15 October 2021 > 15 April 2022

❗️

Deprecation Date: 15 October 2021

Removal Date: 15 April 2022

API_1 (v4)API (v5)
GET

API EndpointNotes
/api_1.php/catalog-viewsAn attribute in the response payload has been replaced:

Deprecated Attribute: type

Replacement Attribute: code

{
    "success": true,
    "total": 1,
    "rows": [
        {
            "id": 1,
            "name": "E-Commerce",
            "type": "ECO", // Deprecated and will be removed
            "code": "ECO", // Should be used instead
            "description": null,
            "fields": [],
            "catalogXObjectTypes": [],
            "objectType": "document"
        }
    ]
}
/api_1.php/catalog-views/__INTERNAL-ID__An attribute in the response payload has been replaced:

Deprecated Attribute: type

Replacement Attribute: code

{
    "success": true,
    "data": {
        "id": 1,
        "name": "E-Commerce",
        "type": "ECO", // Deprecated and will be removed
        "code": "ECO", // Should be used instead
        "description": null,
        "origin_catalog_view_id": null,
        "fields": []
    }
}
CRUD

API Endpoint

Notes

/api_1.php/profiles/picture/:id/:width/:height

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/users

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/users/groups

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/users/groups

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users/groups

/api_1.php/users/

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/users/me

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/users/me/uploadProfilePhoto

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/users/permissions

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/users/validate

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/users-and-groups

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/user-settings

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/users

/api_1.php/xobject_types

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/link-types

/api_1.php/xobject_types/

All HTTP methods are deprecated for this particular endpoint.

Replacement(s): /api/link-types/

CRUD

API Endpoint

Notes

/api/assets/

In the response payload, the attributes.code attribute is deprecated.

attributes is an array of:

  • id
  • code <- deprecated item
  • values
  • /api/catalogs/

    In the response payload, the attributes.code attribute is deprecated.

    attributes is an array of:

  • id
  • code <- deprecated item
  • values
  • /api/documents/

    In the response payload, the attributes.code attribute is deprecated.

    attributes is an array of:

  • id
  • code <- deprecated item
  • values
  • /api/variants/

    In the response payload, the attributes.code attribute is deprecated.

    attributes is an array of:

  • id
  • code <- deprecated item
  • values
  • /api/catalogs/

    In the response payload, the fieldData attribute is deprecated.

    /api/data-flow-profiles/models

    All HTTP methods are deprecated for this particular endpoint.

    Replacement(s)

  • /api/import/models
  • /api/export/models
  • /api/link-types

    In the response payload, the parent and child attributes are deprecated.

    Replacement(s)

  • parent -> origin
  • child -> target