Etsy fields

Your shop objects carry the data Alura syncs from Etsy’s v3 API. Where Etsy’s name is clear, the API keeps it: title, description, tags, materials, state, quantity, skus, who_made, when_made, is_supply and the like. This page lists every field whose name or shape changes, and the Etsy fields left out. The Etsy column shows the field as Alura stores it from Etsy, which follows Etsy’s v3 names.

​

How fields are normalized

​

Listings

Detail also keeps description, tags, materials, skus, has_variations, who_made, when_made, is_supply, is_personalizable, language, shipping_profile_id, return_policy_id and should_auto_renew under Etsy’s names. Alura adds: image_url (the first photo), reviews {count, average} from the stored reviews, sales and period from your orders (Listing stats), and listing_score (Listing score). Etsy has none of these per listing.

​

Images and videos

​

Expansions

Each block carries its own as_of. A block Alura hasn’t fetched yet is null with {block}_error: "not_fetched", never an empty list; a stored block Alura can’t read is null with {block}_error: "unreadable".

​

Left out

user_id, the photo colour fields, digital file_data, featured_rank (see above), and Alura’s own lifetime figures that would mislead: the monthly_* averages, conversion_rate (lifetime views against a partial count of orders) and sold_count.

​

Orders

An order is Etsy’s receipt. Its items are Etsy’s transactions. Alura adds: item_count (the sum of the items’ quantities), items[].image_url, and shipping_address_error, which says why shipping_address is null: etsy_restricted, no_physical_items or not_fetched.

​

Items, shipments, refunds and payment

​

Left out

buyer_email, seller_email, payment_email, message_from_payment, receipt_type, seller_user_id, Alura’s internal IDs, the items’ file_data, buyer_user_id and coupons, the shipments’ mail_class, the refunds’ note_from_issuer, and every payment field except the three amounts.

​

Shops

url, title, announcement, sale_message, digital_sale_message, languages, vacation_message and accepts_custom_requests keep Etsy’s names. Alura adds: connection (whether the Etsy connection works, and what it allows), sync and coverage. See Connect a shop and sync it and Coverage. Left out: login_name, the seller and payment emails, policy_seller_info, Etsy’s onboarding flags and internal IDs.

​

Shop settings

Every settings object carries fetched_at, when Alura last fetched that kind of setting from Etsy. Alura adds: listings_count on a return policy, which Alura counts from your synced listings. Left out: the shipping profile’s origin_postal_code, profile_type, domestic_handling_fee and international_handling_fee, and user IDs.

​

Changes

A change records a write to a listing made through Alura, with its fields’ before and after values. Its field names are the listing’s own Alura names, which differ from what the Alura app stores in a few places: IDs in a change, such as category_id and section_id, are strings. Any other stored field is reported as other.

​

Next steps