HomeGuidesAPI Reference
Guides

Collection Push API

Suggest Edits

The collection Push API allows merchant to set collections in their platform and sync them into Merchandising Cloud.


📘

Review the full swagger documentation: |https://pushapi.findify.io/api-docs


COLLECTION endpoint

This endpoint allows the sync of collection data into findify, it also allows the usage of multiple filter types to be able to create any collection of products needed.

It also provide the ability to send translated data in case of multiple collection slots per collection

This endpoint offers 2 operations

  • POST: to create/update a collection
  • DELETE: to delete a list of collections

Request Sample: Create/Update

curl --location 'https://pushapi.staging.findify.io/collection' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '[
    {
        "filters": [
            {
                "operator": "AND",
                "operands": [
                    {
                        "action": "include",
                        "type": "category",
                        "field": "category",
                        "values": [
                            "Parent category",
                            "Child category"
                        ]
                    },
                    {
                        "action": "include",
                        "type": "term",
                        "field": "tags",
                        "values": [
                            "TAG_NAME"
                        ]
                    },
                    {
                        "action": "include",
                        "type": "term",
                        "field": "brand",
                        "values": [
                            "BRAND_NAME"
                        ]
                    },
                    {
                        "action": "include",
                        "type": "range",
                        "field": "price",
                        "values": [
                            {
                                "to": 50.99
                            }
                        ]
                    },
                    {
                        "action": "include",
                        "type": "range",
                        "field": "quantity",
                        "values": [
                            {
                                "from": 2
                            }
                        ]
                    },
                    {
                        "action": "exclude",
                        "type": "contains-string",
                        "field": "title",
                        "values": [
                            "STRING_TO_USE_FOR_FILTER"
                        ]
                    }
                ]
            }
        ],
        "localeUrls": [
            {
                "url": "URL_IN_SWEDISH",
                "locale": "de"
            },
            {
                "url": "URL_IN_FRENCH",
                "locale": "fr"
            }
        ],
        "externalCollection": { // Free JSON field, id should at the minimum be sent to be able to delete a collection by its external ID
            "id": "123123"
        },
        "slot": "COLLECTION/CATEGORY NAME"
    }
]'

Request Sample: Delete Collections

curl --location --request DELETE 'https://pushapi.staging.findify.io/collection' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '["123123"]'

Updated 6 days ago