Customily

Customily

Customily lets shoppers personalize a product (names, dates, photos, fonts, colours) on a live preview. A product in the Design Studio is a personalization template; a personalization (also called a cart item) is what one shopper created, identified by a personalizationGUID.

This connector uses two documented Customily APIs:

• the Design Studio API at https://app.customily.com/api (Swagger: https://app.customily.com/swagger) for product templates;
• the standalone item API at https://sh.customily.com/api/standalone for personalization details and production files.

Setup

Put the e-mail (or username) and password of your Customily login into CUSTOMILY_USERNAME and CUSTOMILY_PASSWORD. The connector calls POST https://app.customily.com/api/token with grant_type=password and sends the returned JWT as Authorization: Bearer. Tokens last 30 days and are renewed automatically. Accounts that sign in only with Google or Shopify need a password set in Customily first. A team member login sees what that member is allowed to see.

Start here

• customily_count_products checks the login and tells how many templates exist.
• customily_list_products pages through templates (from is the offset, page_size the page length) and returns their ids and names. Filter with search; the API requires a search value, and the default single space matches every template.
• customily_get_product returns one template in full (sides, elements, option sets). The answer can be large.

Orders and production files

• Store the personalizationGUID (from the add-to-cart payload, or the Shopify/Etsy line item property) with the order. customily_get_personalization then returns the shopper's options (optionsJson, a JSON string of name/value/type entries), the previewUrl, the exportedFiles and whether the production file was generated.
• If the store passed its order id when the cart record was created, customily_list_order_personalizations returns every personalized item of that order.
• exportedFiles[].url is a placeholder until the file is generated. customily_generate_production_file triggers it; Customily charges per production file, so call it only for paid orders. It is installed switched off.

Pitfalls

• Template ids and personalization ids are GUIDs; keep the dashes.
• Data for Shopify and Etsy shops that use the Customily app directly may live in the app's own order screens; the standalone item API covers items created through Customily's standalone and custom integrations (cart records).
• No documented rate limit; keep page sizes moderate (20 to 50).