Retailer
A full reference to a retailer type for different Liquid Commerce APIs.
RetailerType
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
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
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
platformFee: number [optional]
platform 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
doesAllowPromos: boolean
indicates whether the retailer per fulfillment level support promo codes for cart & checkout
doesAllowGiftCards: boolean
indicates whether the retailer per fulfillment level support gift cards for checkout
productTypesAllowed: Array<string>
list of fulfillment categories allowed
FeeDelivery
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
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
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
active: boolean
whether free delivery is available
min: number
minimum purchase amount for free delivery
Expectation
detail: string
detailed expectation of fulfillment, ex: Ships in 3 days
short: string
short expectation of fulfillment, ex: 3 days
engraving: string
detailed expectation of engravable shipping fulfillment, ex: Ships in 10 days
Note: engraving attribute will be returned only for shipping fulfillments and not onDemand.
Hours
[DayOfWeek]: DayConfig
hours of operations for each day of the week, ex:
DayConfigs
active: boolean
whether the day is available for scheduling
times: Array<Time>
the times available for scheduling, ex:
Time
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
retailerLast updated