LogoLogo
  • LiquidCommerce Documentation
  • 🔐Authentication API Integration
    • Get Access Token
  • Services
    • 🗺️Address API
      • Autocomplete
      • Details
    • 👥Users API
      • Session
      • Fetch User
      • Delete User
      • Create/Update Address
      • Delete Address
      • Add Payment
      • Update Default Payment
      • Delete Payment
    • 🗃️Catalog API
      • Search
      • Availability
    • 🛒Cart API
      • Create/Update Cart
    • 🛍️Checkout API
      • Prepare
      • Complete
    • 📁Orders API
      • Authentication
      • Get Order
  • CLOUD SDK
    • Overview
    • Methods & Usage
  • EVENTS & ERRORS
    • Overview
    • Cart Events
    • Checkout Status Codes
  • EVENT BRIDGE (WEBHOOKS)
    • Orders
  • Types
    • Loc
    • Catalog
    • Catalog Filters
    • Product
    • Cart
    • User
    • Retailer
    • Checkout
    • Order
Powered by GitBook
On this page
  • CatalogType
  • NavigationSchema
  • CursorSchema
  • Sample catalog
Export as PDF
  1. Types

Catalog

A full reference to a catalog type for different Liquid Commerce APIs.

CatalogType

Attribute
Description

available retailers

matched products

navigation and filtering info

NavigationSchema

Attribute
Description

id: string

navigation session id

correctedQuery: string

spell-corrected search query

attributionToken: string

analytics tracking token

currentPage: number

current page number

totalPages: number

total available pages

totalCount: number

total matching items

availableOrderBy: Array<string>

available sort fields

availableOrderDirections: Array<string>

sort directions

pagination cursors

available filters

CursorSchema

Attribute
Description

nextPageToken: string

token for next page

previousPageToken: string

token for previous page

Sample catalog

Catalog Object
 "products": [
        {
            "id": "ful_def456uvw123",
            "salsifyGrouping": "GRP-78392",
            "name": "Maestro Dobel® Diamante Tequila Cristalino",
            "brand": "Maestro Dobel",
            "catPath": "Spirits > Tequila > Cristalino",
            "category": "",
            "classification": "",
            "type": "",
            "subType": "",
            "region": "Jalisco",
            "country": "Mexico",
            "material": "Agave",
            "color": "White",
            "flavor": "",
            "variety": "100% Blue Agave",
            "appellation": "",
            "abv": "40",
            "proof": "80",
            "age": "",
            "vintage": "",
            "description": "Maestro Dobel® Diamante® is the original Cristalino. Blended extra Añejo, Añejo and reposado tequilas are aged in Balkan new white wood barrels, then filtered again to retain an elegant flavor. The Cristalino tequila has a mild oak aroma with a touch of vanilla. It has a citrus and prickly pear flavor with a smooth, crisp, clean finish. Pour one shot of straight Diamante Tequila to sip, into an old-fashioned glass with ice and a lemon slice, or as a Margarita. (80 proof)",
            "htmlDescription": "<p>Maestro Dobel® Diamante® is the original Cristalino. Blended extra Añejo, Añejo and reposado tequilas are aged in Balkan new white wood barrels, then filtered again to retain an elegant flavor. The Cristalino tequila has a mild oak aroma with a touch of vanilla. It has a citrus and prickly pear flavor with a smooth, crisp, clean finish. Pour one shot of straight Diamante Tequila to sip, into an old-fashioned glass with ice and a lemon slice, or as a Margarita. (80 proof)</p>",
            "tastingNotes": "World's first multi-aged clear tequila.",
            "images": [
                "https://example.com/products/dobel-diamante-1.jpg",
                "https://example.com/products/dobel-diamante-2.jpg"
            ],
            "sizes": [
                {
                    "id": "sz_xy789zw456",
                    "upc": "00811538012034",
                    "size": "750 ML",
                    "volume": "750",
                    "uom": "MILLILITRE",
                    "container": "Bottle",
                    "containerType": "Bottle",
                    "pack": false,
                    "packDesc": "",
                    "image": "https://example.com/products/dobel-diamante-bottle.jpg",
                    "attributes": {
                        "engraving": {
                            "status": true,
                            "maxLines": 3,
                            "maxCharsPerLine": 16,
                            "fee": 5000,
                            "location": "Back of the Bottle"
                        }
                    }
                }
            ]
        },
        {
            "id": "ful_ghi789rst123",
            "salsifyGrouping": "649066c19661fb45f6869934",
            "name": "The Macallan Double Cask 12 Years Old Single Malt Whisky",
            "brand": "The Macallan",
            "catPath": "Spirits > Whiskey > Scotch",
            "category": "",
            "classification": "",
            "type": "",
            "subType": "",
            "region": "Speyside",
            "country": "Scotland",
            "material": "Grain",
            "color": "Tawny/brown",
            "flavor": "",
            "variety": "Barley",
            "appellation": "Speyside",
            "abv": "40",
            "proof": "80",
            "age": "",
            "vintage": "",
            "description": "The Macallan Double Cask 12-Year-Old pairs the indulgent fruit, caramel, and oak spice character of Sherry-seasoned European oak with the bright citrus and vanilla notes of Sherry-seasoned American oak for a satisfyingly rich and perfectly balanced flavor experience. Awarded unanimous Double Gold upon release.",
            "htmlDescription": "<p>The Macallan Double Cask 12-Year-Old pairs the indulgent fruit, caramel, and oak spice character of Sherry-seasoned European oak with the bright citrus and vanilla notes of Sherry-seasoned American oak for a satisfyingly rich and perfectly balanced flavor experience. Awarded unanimous Double Gold upon release.</p>",
            "tastingNotes": "\"If there is royalty in the whisky world, it belongs to Scotland, and if there is a king of Scotch whisky, it's The Macallan.\" – Forbes",
            "images": [
                "https://example.com/products/macallan-12-1.jpg"
            ],
            "sizes": [
                {
                    "id": "sz_pqr123mn456",
                    "upc": "00812066021598",
                    "size": "750 ML",
                    "volume": "750",
                    "uom": "MILLILITRE",
                    "container": "Bottle",
                    "containerType": "Bottle",
                    "pack": false,
                    "packDesc": "",
                    "image": "https://example.com/products/macallan-12-bottle.jpg",
                    "attributes": {
                        "engraving": {
                            "status": true,
                            "maxLines": 3,
                            "maxCharsPerLine": 16,
                            "fee": 5000,
                            "location": "Below the Label"
                        }
                    }
                }
            ]
        }
    ],
    "retailers": [
        {
            "id": "ret_abc123xyz789",
            "name": "LiquidCommerce Wine & Spirits",
            "platformFee": 499,
            "address": {
                "one": "240 Loisaida Avenue",
                "two": "",
                "city": "New York",
                "state": "NY",
                "zip": "10009",
                "country": "US"
            },
            "fulfillments": [
                {
                    "id": "ful_ghi189rst123",
                    "timezone": "America/New_York",
                    "type": "onDemand",
                    "canEngrave": false,
                    "fees": {
                        "min": 1999,
                        "fee": 0,
                        "free": {
                            "active": false,
                            "min": 0
                        }
                    },
                    "expectation": {
                        "detail": "Arrives in 60 mins",
                        "short": "60 mins"
                    },
                    "hours": {
                        "monday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "10:00",
                                    "endsAt": "21:00"
                                }
                            ]
                        },
                        "tuesday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "10:00",
                                    "endsAt": "21:00"
                                }
                            ]
                        },
                        "wednesday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "10:00",
                                    "endsAt": "21:00"
                                }
                            ]
                        },
                        "thursday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "10:00",
                                    "endsAt": "21:00"
                                }
                            ]
                        },
                        "friday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "10:00",
                                    "endsAt": "21:00"
                                }
                            ]
                        },
                        "saturday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "10:00",
                                    "endsAt": "21:00"
                                }
                            ]
                        },
                        "sunday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "10:00",
                                    "endsAt": "21:00"
                                }
                            ]
                        }
                    },
                    "breaks": [],
                    "items": []
                }
            ]
        },
        {
            "id": "ret_abc123xyz189",
            "name": "LiquidCommerce Barn",
            "platformFee": 499,
            "address": {
                "one": "1000 N 5th Ave",
                "two": "134",
                "city": "Vernon Hills",
                "state": "NY",
                "zip": "10061",
                "country": "US"
            },
            "fulfillments": [
                {
                    "id": "ful_abc123xyz189",
                    "timezone": "America/Chicago",
                    "type": "shipping",
                    "canEngrave": true,
                    "fees": {
                        "pack": {
                            "active": true,
                            "maxQuantity": 25,
                            "fee": 1599
                        },
                        "individual": {
                            "active": true,
                            "maxQuantity": 25,
                            "fee": 1599
                        },
                        "free": {
                            "active": false,
                            "min": 0
                        }
                    },
                    "expectation": {
                        "detail": "Ships in 2-3 days",
                        "short": "2-3 days"
                    },
                    "hours": {
                        "monday": {
                            "active": false,
                            "times": []
                        },
                        "tuesday": {
                            "active": false,
                            "times": []
                        },
                        "wednesday": {
                            "active": false,
                            "times": []
                        },
                        "thursday": {
                            "active": false,
                            "times": []
                        },
                        "friday": {
                            "active": false,
                            "times": []
                        },
                        "saturday": {
                            "active": false,
                            "times": []
                        },
                        "sunday": {
                            "active": false,
                            "times": []
                        }
                    },
                    "breaks": [],
                    "items": []
                }
            ]
        }
    ]
PreviousLocNextCatalog Filters

Last updated 7 months ago

retailers: Array<>

products: Array<>

navigation:

cursor:

filters:

Retailer
Product
NavigationSchema
CursorSchema
FilterSchema