Retailer

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

RetailerType

Attribute	Description
id: string	retailer identifier
name: string	retailers name, ex: Liquid Wine and Spirits
platformFee: number [optional]	LiquidCommerce application fee per retailer
address: RetailerAddress [optional]	location information split out to individual values for the street, city, state, zip code, country, latitude and longitude
fulfillments: Array<RetailerFulfillment>	retailer available fulfillment configurations

RetailerAddress

Attribute	Description
id: string [optional]	identifier of the address
one: string	retailer street address
two: string	retailer apt, suite, floor, etc
city: string	retailer city
state: string	retailer state, you can use either 2 letter code or the full name
zip: string	retailer zip code
country: string	retailer country where the address is located
lat: number	retailer latitude, ex: 40.744860
long: number	retailer longitude, ex: -73.985314

RetailerFulfillment

Attribute	Description
id: string	fulfillment identifier
type: Modalities	fulfillment type, ex: onDemand | shipping
canEngrave: boolean	indicates whether the retailer support engraving services
deliveryFee: number [optional]	specific delivery fee for this fulfillment
shippingFee: number [optional]	specific shipping fee for this fulfillment
engravingFee: number [optional]	specific engraving fee for this fulfillment
subtotal: number [optional]	Subtotal for items in this fulfillment
timezone: string [optiona]	timezone associated with the fulfillment
fees: FeeShipping | FeeDelivery	fulfillment's fee configurations, if the fulfillment type is shipping(FeeShipping), if the fulfillment type is onDemand(FeeDelivery)
expectation: Expectation	fulfillment's expectation configurations
hours: Hours	fulfillment's hours configurations
breaks: Array<Time>	the breaks within the working hours
items: Array<string>	fulfillment's item ids
productTypeAllowed: Array<string>	list of fulfillment categories allowed

FeeDelivery

Attribute	Description
min: number	the minimum subtotal that must be met for the order to be placed
fee: number	the fee for the fulfillment service, ex: 1500
free: FreeDelivery	conditions for free delivery

FeeShipping

Attribute	Description
pack: FeeShippingConfig	the shipping fee configurations for pack items
individual: FeeShippingConfig	the shipping fee configurations for individual items
free: FreeDelivery	conditions for free delivery

FeeShippingConfig

Attribute	Description
fee: number	The fee for the fulfillment service, ex: 1500
active: boolean	The status of of the fulfillment shipping method
min: number	The min item total required to checkout
maxQuantity: number	The maximum number of products allowed

FreeDelivery

Attribute	Description
active: boolean	whether free delivery is available
min: number	minimum purchase amount for free delivery

Expectation

Attribute	Description
detail: string	detailed expectation of fulfillment, ex: Ships in 3 days
short: string	short expectation of fulfillment, ex: 3 days

Hours

Attribute	Description
[DayOfWeek]: DayConfig enum DAY_OF_WEEK { MONDAY = 'monday', TUESDAY = 'tuesday', WEDNESDAY = 'wednesday', THURSDAY = 'thursday', FRIDAY = 'friday', SATURDAY = 'saturday', SUNDAY = 'sunday' }	hours of operations for each day of the week, ex: "monday": { "active": true, "times": [ { "startsAt": "00:00", "endsAt": "23:59" } ] }

DayConfigs

Attribute	Description
active: boolean	whether the day is available for scheduling
times: Array<Time>	the times available for scheduling, ex: "times": [ { "startsAt": "00:00", "endsAt": "23:59" } ]

Time

Attribute	Description
startsAt: string	the expected start time for the day, ex: 08:30
endsAt: string	the expected end time for the day, ex: 23:00

Sample retailer

Retailer Object

[
    {
            "id": "retailerId_123abc123abc",
            "name": "Cheers On Demand",
            "platformFee": 499,
            "address": {
                "one": "867 Fillmore St",
                "two": "",
                "city": "San Francisco",
                "state": "CA",
                "zip": "94117",
                "country": "US"
            },
            "fulfillments": [
                {
                    "id": "6570c3ec700628ce1910c155",
                    "timezone": "America/Los_Angeles",
                    "type": "onDemand",
                    "canEngrave": false,
                    "fees": {
                        "min": 2500,
                        "fee": 0,
                        "free": {
                            "active": false,
                            "min": 2500
                        }
                    },
                    "expectation": {
                        "detail": "Arrives in 60 mins",
                        "short": "60 mins"
                    },
                    "hours": {
                        "monday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "08:00",
                                    "endsAt": "23:30"
                                }
                            ]
                        },
                        "tuesday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "08:00",
                                    "endsAt": "23:30"
                                }
                            ]
                        },
                        "wednesday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "08:00",
                                    "endsAt": "23:30"
                                }
                            ]
                        },
                        "thursday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "08:00",
                                    "endsAt": "23:30"
                                }
                            ]
                        },
                        "friday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "08:00",
                                    "endsAt": "23:30"
                                }
                            ]
                        },
                        "saturday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "08:00",
                                    "endsAt": "23:59"
                                }
                            ]
                        },
                        "sunday": {
                            "active": true,
                            "times": [
                                {
                                    "startsAt": "08:00",
                                    "endsAt": "23:59"
                                }
                            ]
                        }
                    },
                    "breaks": [],
                    "items": []
                }
            ]
        }
]