search

products.update

Update already existing product within flipsnack

The products.update method allows external systems (such as a PIM or ERP) to send full or partial product data directly to Flipsnack. Each request has a limitation of 500 products per request and must include an apiKey, signature for authentication, a sourceHash to know exactly which feeds products to update and the product list with the updated fields there is no need to send full products it’s enough to send only the updated fields.The last step is data validation and if all goes well the updated products will be available under the Automation tab in the Design Studio.

Note: Requests must be made to https://api.flipsnack.com/v1.

hashtag
Request parameters

Name

Type

Description

apiKey (required)

string

The API key provided for your user. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". If the key is incorrect the request returns the error code "41 - Invalid credentials".

signature (required)

string

The signature must be calculated by you and added to the request. See How to sign a requestarrow-up-right for more information.If the parameter is missing the request will return the error code "30 - Missing mandatory parameter". If the signature is incorrect the request will return the error code "44 - Invalid signature".

action (required)

string

The API method that should be called. In this case the value should be products.update . If it is not specified, the request will return the error code "30 - Missing mandatory parameter".

sourceHash (required)

string

This needs to be a unique identifier within flipsnack to be able to update based on it the products and also to have the possibility to create multiple feeds from the same API

products(required)

JSON

It’s a JSON containing all the products that are going to pe created

feedName

string

The name displayed in automation page in app

hashtag
Products example as JSON type

This is an example of how one structure of product with one variant (if needed) should look like.

[
    {
        "type": string, // required
        "code": string, // required
        "title": string,
        "description": string,
        "image_link": string,
        "sell_price": number,
        "currency": string,
        "discount_price": number,
        "quantity": boolean,
        "purchasable_qty": {
            "min": number,
            "max": number
        },
        "attribute": {
            "name1": string,
            "options1": string,
            "name2": string,
            "options2": string,
            "name3": string,
            "options3": string
        },
        "image_attribute": string,
        "shop_element": string,
        "area_element": {
            "tooltip": string,
            "color": string,
            "opacity": number
        },
        "shop_button": {
            "color": string,
            "label": string,
            "label_color": string
        },
        "website": {
            "button": boolean,
            "button_label": string,
            "link": string
        },
        "customizable_product": {
            "product": boolean,
            "instructions": string,
            "flat_fee": number,
            "per_character": number,
            "character_length": number,
            "mandatory": boolean
        },
        "variants": [
            {
                "code": string,
                "parent_code": string,
                "image_link": string,
                "visible": boolean,
                "attribute": {
                    "options1": string,
                    "options2": string,
                    "options3": string
                },
                "price": number,
                "discount_price": number
            }
        ]
    }
]

hashtag
Products JSON Example

In the next example there is only one product but you can send a maximum of 500 products per request also the required fields have a comment “// required” all the rest of the fields are optional and need to be sent only if they change

hashtag
Response parameters

Name

Type

Description

code

string

Possible values:

  • 200: When all goes well and action is executed correctly

  • 400: When data submitted has invalid data of wrong format

  • 51: When the mac number of products sent is exceeded

  • 30: Missing a mandatory parameter

status

string

Message related to code

data

JSON

It's a JSON with more details about the response it has a more detailed message about the outcome, errors or data which is an array of exact messages

hashtag
Error codes

For complete list of error codes and messages go to API status codes section.

hashtag
Examples

hashtag
Request

hashtag
Response

Previousproducts.createNextproducts.delete

Last updated