Product Assets

The Product Assets Import Endpoint

https://{BASE_URL}/imports/product_assets

All import integration endpoints use the same authentication parameters, please see Authentication page for more details.

E.g.:

https://{BASE_URL}/imports/product_assets

For further clarification of the Market concept, please read the Vocabulary.

You may post any amount of Product Assets to the endpoint. Existing product assets are overwritten based on their id. The order defined in the JSON is the order that is used in the presentation in the POS app.

The below example shows all currently supported mime types in Ka-ching.

Image assets are shown both in POS and TAS mode in the app. Documents and Video links are only shown in TAS mode in the app. Please note is that the YouTube and Vimeo links are socalled "embed" links. The model/usdz type allows you to show augmented reality models of your product in the app.

Image assets are downloaded to Ka-ching storage if an image import is configured on the account. Video links are embedded into the product details page and the pdf documents are fetched via the URL reference when shown or shared with the customer.

JSON Example

{
    "assets": {
        "ipad-pro-9-7": [
            {
                "mime_type": "image/jpg",
                "name": "iPad Pro 9.7 Landscape", // L10nString
                "url": "https://example.com/ipad-pro-9-7.jpg"
            },
                            {
                "mime_type": "image/jpeg",
                "name": "iPad Pro 9.7 Portrait",
                "url": "https://example.com/ipad-pro-9-7-2.jpeg"
            },
            {
                "mime_type": "image/png",
                "name": "iPad Pro 9.7 Back",
                "url": "https://example.com/ipad-pro-9-7-3.png"
            },
            {
                "mime_type": "video/youtube",
                "name": "iPad Pro 9.7 Review",
                "url": "https://www.youtube.com/embed/pi3k3ZPiK7M"
            },
            {
                "mime_type": "video/vimeo",
                "name": "iPad Pro 9.7 Video 2",
                "url": "https://player.vimeo.com/video/286871958"
            },
            {
                "mime_type": "document/pdf",
                "name": "iPad Pro 9.7 Specs",
                "url": "https://example.com/ipad-pro-9-7.pdf"
            },
            {
                "mime_type": "model/vnd.usdz+zip",
                "name": "Cosmonaut",
                "url": "https://developer.apple.com/augmented-reality/quick-look/models/cosmonaut/CosmonautSuit_en.reality"
            }
        ]
    }
}

L10nString is a localized string.

Deleting Product Assets

Send an HTTP DELETE request to the endpoint with a ids query parameter with a comma separated list of product ids where you want to remove all assets

[
https://{BASE_URL}/imports/product_assets?ids=ipad-pro-9-7,ipad-mini,ipad-2
]