String docs
Site integrations

Zola

Zola wedding websites and registries: the couple's names, wedding date and city, the site's page list, and every registry item with its price, retailer and the couple's own note.

Call these actions with your String API key; see Authentication. Every call answers with the envelope described in Responses & errors, whose data holds the rows below.

  • Site: zola
  • Version: 1.0.0
  • Reads from: www.zola.com
ActionDescriptionListed price
weddingRead a Zola wedding website's summary: both partners' names, the wedding date, city and timezone, whether it is published and indexable, and every tab the site serves (schedule, travel, registry, photos, things to do, FAQs).Billed per request at your plan's rates
registryRead every item on a Zola wedding registry: name, price, retailer or Zola product, the couple's own note, quantities wanted and bought, cash-fund and group-gift goals with what they have raised, and contributor counts.Billed per request at your plan's rates

wedding

Read a Zola wedding website's summary: both partners' names, the wedding date, city and timezone, whether it is published and indexable, and every tab the site serves (schedule, travel, registry, photos, things to do, FAQs).

POST https://request.usestring.ai/v1/integrations/zola/wedding

Input

Unknown fields are rejected.

FieldTypeDescription
slugstringRequired. The wedding website: its Zola slug, such as halieandkeaton, or a zola.com/wedding/<slug> URL. At least 1 character.

Output

data is an array of rows, one per result. Each row has:

FieldTypeDescription
slugstringThe wedding's Zola slug.
urlstringThe website's home page.
titlestring | nullThe site's title, usually the couple's first names.
ownerFirstNamestring | nullThe first partner's first name.
ownerLastNamestring | nullThe first partner's last name.
partnerFirstNamestring | nullThe second partner's first name.
partnerLastNamestring | nullThe second partner's last name.
citystring | nullThe wedding's city.
stateProvincestring | nullThe wedding's state or province.
timezonestring | nullThe wedding's IANA timezone.
weddingDatestring | nullThe wedding date, as YYYY-MM-DD.
publishedbooleanTrue while the website is live.
accountUuidstring | nullThe wedding account's Zola id.
registryPublishedbooleanTrue when the couple has published a Zola registry.
showsRegistrybooleanTrue when the site links its registry tab.
searchEngineIndexablebooleanTrue when the site asks to be indexed, the flag that makes name search reach it.
pagesobject[]The website's tabs in nav order.
pages[].titlestringThe tab's label, such as Schedule or Things To Do.
pages[].slugstringThe tab's path under /wedding/<slug>/, such as event or poi.
pages[].typestringThe tab's kind: HOME, EVENT, TRAVEL, REGISTRY, PHOTO, POI or FAQ.
pages[].urlstringThe tab's page.

Example

curl https://request.usestring.ai/v1/integrations/zola/wedding \
  -H "Authorization: Bearer $STRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "halieandkeaton"
  }'

data starts with these rows:

[
  {
    "slug": "halieandkeaton",
    "url": "https://www.zola.com/wedding/halieandkeaton",
    "title": "Halie & Keaton",
    "ownerFirstName": "Halie",
    "ownerLastName": "Nagel",
    "partnerFirstName": "Keaton",
    "partnerLastName": "Inglis",
    "city": "Ludington",
    "stateProvince": "MI",
    "timezone": "America/New_York",
    "weddingDate": "2024-10-26",
    "published": true,
    "accountUuid": "77d7f3c8-6b81-494f-8731-30ea41db5709",
    "registryPublished": true,
    "showsRegistry": true,
    "searchEngineIndexable": true,
    "pages": [
      {
        "title": "Home",
        "slug": "home",
        "type": "HOME",
        "url": "https://www.zola.com/wedding/halieandkeaton"
      },
      {
        "title": "Schedule",
        "slug": "event",
        "type": "EVENT",
        "url": "https://www.zola.com/wedding/halieandkeaton/event"
      },
      {
        "title": "Travel",
        "slug": "travel",
        "type": "TRAVEL",
        "url": "https://www.zola.com/wedding/halieandkeaton/travel"
      },
      {
        "title": "Registry",
        "slug": "registry",
        "type": "REGISTRY",
        "url": "https://www.zola.com/wedding/halieandkeaton/registry"
      },
      {
        "title": "Gallery",
        "slug": "photo",
        "type": "PHOTO",
        "url": "https://www.zola.com/wedding/halieandkeaton/photo"
      },
      {
        "title": "Things To Do",
        "slug": "poi",
        "type": "POI",
        "url": "https://www.zola.com/wedding/halieandkeaton/poi"
      },
      {
        "title": "FAQs",
        "slug": "faq",
        "type": "FAQ",
        "url": "https://www.zola.com/wedding/halieandkeaton/faq"
      }
    ]
  }
]

Requests and billing

  • Requests: 1 Web Access request per call.
  • Billing: passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.

registry

Read every item on a Zola wedding registry: name, price, retailer or Zola product, the couple's own note, quantities wanted and bought, cash-fund and group-gift goals with what they have raised, and contributor counts.

POST https://request.usestring.ai/v1/integrations/zola/registry

Input

Unknown fields are rejected.

FieldTypeDescription
slugstringRequired. The wedding website: its Zola slug, such as halieandkeaton, or a zola.com/wedding/<slug> URL. At least 1 character.

Output

data is an array of rows, one per result. Each row has:

FieldTypeDescription
positionintegerThe item's place on the registry, from 1.
itemIdstringThe item's Zola id.
namestring—
kindstringzola for a product Zola sells, external for a retailer product the registry links to, cash for a cash fund.
pricenumber | nullThe item's price in dollars; for a cash fund, the suggested contribution.
storestring | nullWho sells it: the retailer's name, or Zola.
urlstring | nullThe retailer product URL the registry links to, for external items.
personalNotestring | nullThe couple's own note on the item.
mostWantedbooleanThe couple marked it a top pick.
imageUrlstring | null—
descriptionstring | nullThe product's description as plain text.
detailsobject[] | nullThe item's label/value spec list, such as materials and dimensions.
details[].labelstring—
details[].valuestring—
quantityNeededintegerHow many the couple wants.
quantityFundedintegerHow many are already bought, for a product.
fulfilledbooleanTrue once the item is fully bought or funded.
reservedbooleanTrue when someone has claimed it without completing the purchase.
cashFundbooleanTrue for a cash goal, not a product.
groupGiftbooleanTrue when the item takes contributions from several givers.
goalAmountnumber | nullA cash fund or group gift's target in dollars.
fundedAmountnumber | nullWhat a cash fund or group gift has raised so far, in dollars.
percentCompleteinteger | nullHow far the item is toward funded, 0-100.
contributorsinteger | nullHow many people have contributed.
stillNeedsstring | nullWhat is left, as the page phrases it.
freeShippingboolean—
discontinuedbooleanTrue when Zola no longer sells the item.

Example

curl https://request.usestring.ai/v1/integrations/zola/registry \
  -H "Authorization: Bearer $STRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "halieandkeaton"
  }'

data starts with these rows:

[
  {
    "position": 1,
    "itemId": "656fe501c8e60603fce7f6ef",
    "name": "Honeymoon Fund",
    "kind": "cash",
    "price": 1000,
    "store": "Zola",
    "url": null,
    "personalNote": "We've been fortunate enough to already have most of what we need for our apartment. Instead of receiving physical gifts, we would love to create lifelong memories. Please consider making a contribution to our honeymoon fund.",
    "mostWanted": true,
    "imageUrl": "https://d35uzl96cmnmq2.cloudfront.net/processed/Resort_A_1600.jpg",
    "description": null,
    "details": [],
    "quantityNeeded": 1,
    "quantityFunded": 0,
    "fulfilled": false,
    "reserved": false,
    "cashFund": true,
    "groupGift": true,
    "goalAmount": 100000,
    "fundedAmount": 650,
    "percentComplete": 0,
    "contributors": 5,
    "stillNeeds": "$99,350",
    "freeShipping": false,
    "discontinued": false
  },
  {
    "position": 2,
    "itemId": "6554e4c8f153e322e4c29de1",
    "name": "NewlyNamed Box | Personalized Name Change After Marriage Kit | Gift Card",
    "kind": "external",
    "price": 89,
    "store": "Amazon",
    "url": "https://www.amazon.com/wedding/share/halieandkeaton",
    "personalNote": null,
    "mostWanted": false,
    "imageUrl": "https://images.zola.com/0a3acd67-0c48-4129-8b0b-15125723eafd?fit=fill&w=640&h=640",
    "description": null,
    "details": [],
    "quantityNeeded": 1,
    "quantityFunded": 0,
    "fulfilled": false,
    "reserved": false,
    "cashFund": false,
    "groupGift": false,
    "goalAmount": null,
    "fundedAmount": null,
    "percentComplete": 0,
    "contributors": null,
    "stillNeeds": "1",
    "freeShipping": false,
    "discontinued": false
  },
  {
    "position": 3,
    "itemId": "6554e56bf153e322e4c29ded",
    "name": "Le Creuset ® Cream Dinner Plates, Set of 4",
    "kind": "external",
    "price": 81.95,
    "store": "Crate & Barrel",
    "url": "https://www.crateandbarrel.com/gift-registry/g/r6819261",
    "personalNote": null,
    "mostWanted": false,
    "imageUrl": "https://images.zola.com/559ada74-6a8a-4344-8bcc-b5e805e794b9?fit=fill&w=640&h=640",
    "description": null,
    "details": [],
    "quantityNeeded": 1,
    "quantityFunded": 0,
    "fulfilled": false,
    "reserved": false,
    "cashFund": false,
    "groupGift": false,
    "goalAmount": null,
    "fundedAmount": null,
    "percentComplete": 0,
    "contributors": null,
    "stillNeeds": "1",
    "freeShipping": false,
    "discontinued": false
  }
]

Requests and billing

  • Requests: 1 Web Access request per call.
  • Billing: passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.