Type Definitions

Type Aliases

AddressStorePayload

AddressStorePayload: Object

Shipping address store payload

Example

const address = {
  addressOne: '123 Main St',
  addressTwo: 'Apt 4B',
  city: 'New York',
  countryId: 230,
  firstName: 'John',
  lastName: 'Doe',
  phone: '+15105829395',
  regionId: 2472,
  zip: '12992'
}

Type declaration

NameType
addressOnestring
addressTwostring | null
citystring
countryIdID
firstNamestring
lastNamestring
phone?string
region?string
regionId?ID
zipstring

AttributeValue

AttributeValue: Object

Type declaration

NameType
idID
namestring

AuthResourceLoginPayload

AuthResourceLoginPayload: Object

Sign-in request payload

Type declaration

NameType
emailstring
passwordstring

AuthResourceLoginResponse

AuthResourceLoginResponse: Object

Successful client authentication response

Type declaration

NameType
accessTokenstring
expiresInnumber

AuthResourceOtpLoginPayload

AuthResourceOtpLoginPayload: Object

OTP sign-in request payload

Type declaration

NameType
emailstring
tokenstring

AuthResourceOtpPayload

AuthResourceOtpPayload: Object

OTP request payload

Type declaration

NameType
emailstring

AuthResourceRegisterPayload

AuthResourceRegisterPayload: Object

User registration payload

Example

const payload = {
  email: '[email protected]',
  firstName: 'John',
  lastName: 'Doe'
}

Type declaration

NameType
emailstring
firstNamestring
lastNamestring
password?string

AuthResourceRegisteredPayload

AuthResourceRegisteredPayload: Object

Email registered request payload

Type declaration

NameType
emailstring

AuthResourceRegisteredResponse

AuthResourceRegisteredResponse: Object

Email registered response

Type declaration

NameType
registeredboolean

AuthResourceSocialPayload

AuthResourceSocialPayload: Object

SSO sign-in payload

Type declaration

NameType
provider"google" | "facebook"
tokenstring

Bundle

Bundle: Object

Type declaration

NameType
appearanceTypeBundleAppearanceType
configurableboolean
createdAtstring
descriptionstring | null
discountTypeBundleDiscountType | null
discountsBundleDiscount[]
filtersBundleFilter[]
hiddenItemsboolean
idID
namestring
plansBundlePlan[]
preferencesBundlePreference[]
priceTypeBundlePriceType | null
quantitySelectorsBundleQuantitySelector[] | null
rulesetsBundleRuleset[]
updatedAtstring

BundleAppearanceType

BundleAppearanceType: "one_step" | "two_step" | "without_ruleset" | "after_checkout"


BundleDiscount

BundleDiscount: Object

Type declaration

NameType
createdAtstring
idID
planIdID
rangesBundleDiscountRange[]
rulesetIdID
updatedAtstring

BundleDiscountRange

BundleDiscountRange: Object

Type declaration

NameType
amountOffnumber | null
percentOffnumber | null
rangenumber

BundleDiscountType

BundleDiscountType: "per_item" | "total" | "percentage"


BundleExpandProperty

BundleExpandProperty: "plans.variants" | "plans.pricings" | "plans.variants.parent" | "plans.pricings.parent" | string


BundleFilter

BundleFilter: Object

Type declaration

NameType
attributeIdID
createdAtstring
idID
namestring
updatedAtstring
valuesAttributeValue[]

BundleItem

BundleItem: Object

Type declaration

NameType
createdAtstring
extraPricenumber
idID
positionnumber
productProductVariant
productIdProductVariant["id"]
quantitynumber
settingsBundleItemSettings[]
updatedAtstring
stockCount`number

BundleItemExpandProperty

BundleItemExpandProperty: "product" | "product.parent" | string


BundleItemSettings

BundleItemSettings: Object

Type declaration

NameType
createdAtstring
idID
maxQuantitynumber
rulesetIdID
updatedAtstring

BundleItemsParamFilter

BundleItemsParamFilter: Object

Type declaration

NameType
attributeIdID
valuesID[]

BundleItemsParams

BundleItemsParams: Object

Type declaration

NameType
expand?BundleItemExpandProperty[]
filters?BundleItemsParamFilter[]
page?number
perPage?number
productIds?ProductVariant["id"][]

BundleItemsResponse

BundleItemsResponse: Object

Type declaration

NameType
dataBundleItem[]
paginationPagination

BundlePayloadItem

BundlePayloadItem: Object

Type declaration

NameType
productIdID
quantitynumber

BundlePayloadPreference

BundlePayloadPreference: Object

Type declaration

NameType
attributeIdID
valuesID[]

BundlePlan

BundlePlan: Object

Type declaration

NameType
idID
pricingsProductPricing[] | null
variantsProductVariant[] | null

BundlePreference

BundlePreference: Object

Type declaration

NameType
attributeIdID
createdAtstring
idID
titlestring
updatedAtstring
valuesAttributeValue[]

BundlePriceType

BundlePriceType: "per_item" | "total"


BundleQuantitySelector

BundleQuantitySelector: number


BundleQuote

BundleQuote: Object

Type declaration

NameType
discountnumber
itemsBundleQuoteItem[]
pricenumber
productProduct
productIdID
quantitynumber
subTotalnumber
taxAmountnumber
taxInclusivenumber
taxRatenumber
totalnumber

BundleQuoteExpandProperty

BundleQuoteExpandProperty: "items.product" | "items.product.parent" | string


BundleQuoteItem

BundleQuoteItem: Object

Type declaration

NameType
discountboolean
pricenumber
productProductVariant
productIdID
quantitynumber
subTotalnumber
taxAmountnumber
taxInclusiveboolean
taxRatenumber
totalnumber

BundleQuoteParams

BundleQuoteParams: Object

Type declaration

NameType
expand?BundleQuoteExpandProperty[]

BundleQuotePayload

BundleQuotePayload: Object

Type declaration

NameType
itemsBundlePayloadItem[]
preferencesBundlePayloadPreference[]
productIdID
quantitynumber

BundleRequestHeaders

BundleRequestHeaders: RequestHeaders & { x-currency?: string }


BundleResourceParams

BundleResourceParams: Object

Type declaration

NameType
expandBundleExpandProperty[]

BundleRuleset

BundleRuleset: Object

Type declaration

NameType
createdAtstring
ctaTextstring | null
idID
maxQuantitynumber
minQuantitynumber
namestring
productsParentProduct[]
updatedAtstring

CartBalanceChange

CartBalanceChange: Object

Type declaration

NameType
amountnumber
currencyCodestring

CartCreatePayload

CartCreatePayload: Object

Type declaration

NameType
couponCode?SubblyCart["couponCode"]
currencyCode?SubblyCart["currencyCode"]
giftCardCode?SubblyCart["giftCardCode"]
referralId?ID | null

CartCustomerData

CartCustomerData: Object

Type declaration

NameType
emailstring
firstNamestring
lastNamestring
marketingConsent?boolean
tosConsent?boolean

CartDiscount

CartDiscount: Object

Type declaration

NameType
chargeNowboolean
descriptionstring
totalnumber
typeDiscountType

CartExpandableProperties

CartExpandableProperties: "coupon" | "gift_card" | "items.product" | "items.product.parent" | "items.product.parent.pricings" | "items.bundle.items.product" | "items.bundle.items.product.parent" | "shipping_method" | "shipping_address" | "payment_method" | "billing_address" | string


CartGiftInfo

CartGiftInfo: Object

Type declaration

NameType
messagestring | null
numberOfOrdersnumber | null
recipientEmail?string | null
startsAtstring | null

CartItem

CartItem: CartItemOneTime | CartItemSubscription


CartItemAddPayload

CartItemAddPayload: CartItemAddPayloadSubscription | CartItemAddPayloadOneTime | CartItemAddPayloadBundle


CartItemAddPayloadBase

CartItemAddPayloadBase: Object

Type declaration

NameType
productIdnumber
quantity?number

CartItemAddPayloadBundle

CartItemAddPayloadBundle: CartItemAddPayloadBase & CartItemUpdatePayloadBundle


CartItemAddPayloadOneTime

CartItemAddPayloadOneTime: CartItemAddPayloadBase & CartItemUpdatePayloadOneTime


CartItemAddPayloadSubscription

CartItemAddPayloadSubscription: CartItemAddPayloadBase & CartItemUpdatePayloadSubscription


CartItemBase

CartItemBase: Object

Type declaration

NameType
amountOffnumber | null
chargeNowboolean
createdAtstring
descriptionstring
discountnumber
idstring
origin"pre_purchase" | "mid_purchase" | "post_purchase" | null
percentOffnumber | null
pricenumber
quantitynumber
subTotalnumber
taxAmountnumber
taxInclusiveboolean
taxRatenumber
totalnumber
updatedAtstring

CartItemBundle

CartItemBundle: Object

Type declaration

NameType
itemsBundleItem[]
preferencesCartItemBundlePreference[]

CartItemBundlePreference

CartItemBundlePreference: Object

Type declaration

NameType
attributeIdID
valuesID[]

CartItemOneTime

CartItemOneTime: CartItemBase & { addon: boolean ; addonDuration: number ; bundle: CartItemBundle | null ; giftCard?: GiftCardRecipient ; parent: number ; product: ProductVariant ; productId: ProductVariant["id"] ; productName: string ; type: oneTime }


CartItemSubscription

CartItemSubscription: CartItemBase & { bundle: CartItemBundle | null ; options: SubscriptionSurvey | null ; product: ProductPricing ; productId: ProductPricing["id"] ; productName: string ; subscription: CartItemSubscriptionInfo ; type: subscription }


CartItemSubscriptionInfo

CartItemSubscriptionInfo: Object

Type declaration

NameType
firstPaymentAtstring
firstShipmentAtstring
nextPaymentAtstring
numberOfShipments1

CartItemUpdatePayloadBundle

CartItemUpdatePayloadBundle: Object

Type declaration

NameType
bundle?{ items: BundlePayloadItem[] ; preferences: BundlePayloadPreference[] }
bundle.itemsBundlePayloadItem[]
bundle.preferencesBundlePayloadPreference[]
options?SubscriptionSurveyOption[] | null
quantity?number

CartItemUpdatePayloadOneTime

CartItemUpdatePayloadOneTime: Object

Type declaration

NameType
addon?boolean
addonDuration?number | 0 | 1
giftCard?GiftCardRecipient | null
quantity?number

CartItemUpdatePayloadSubscription

CartItemUpdatePayloadSubscription: Object

Type declaration

NameType
options?SubscriptionSurveyOption[] | null
quantity?number

CartResourceGiftingDatesResponse

CartResourceGiftingDatesResponse: Object

Type declaration

NameType
availableDatesstring[]
range[string, string]

CartResourceParams

CartResourceParams: Object

Type declaration

NameType
expandCartExpandableProperties[]

CartResourceUpdateItemPayload

CartResourceUpdateItemPayload: CartItemUpdatePayloadSubscription | CartItemUpdatePayloadOneTime | CartItemUpdatePayloadBundle


CartShippingMethodsParams

CartShippingMethodsParams: Object

Type declaration

NameType
countryIdCountry["id"]
regionId?CountryRegion["id"]
zipstring

CartSummaryItem

CartSummaryItem: CartSummaryItemOneTime | CartSummaryItemSubscription | CartSummaryItemSetupFee | CartSummaryItemSurvey


CartSummaryItemBase

CartSummaryItemBase: Object

Type declaration

NameType
chargeNowboolean
discountnumber | null
itemIdCartItem["id"]
pricenumber
quantitynumber
subTotalnumber
taxAmountnumber
taxInclusiveboolean
taxRatenumber
totalnumber
typeCartSummaryItemType

CartSummaryItemOneTime

CartSummaryItemOneTime: CartSummaryItemBase & { bundleItems: SummaryBundleItem[] | null ; productId: ProductOneTime["id"] ; type: oneTime }


CartSummaryItemSetupFee

CartSummaryItemSetupFee: CartSummaryItemBase & { productId: ID }


CartSummaryItemSubscription

CartSummaryItemSubscription: CartSummaryItemBase & { bundleItems: SummaryBundleItem[] | null ; productId: ProductSubscription["id"] ; subscription: SummarySubscriptionItemInfo ; type: subscription }


CartSummaryItemSurvey

CartSummaryItemSurvey: CartSummaryItemBase & { productId: ID }


CartUpdatePayload

CartUpdatePayload: Object

Type declaration

NameType
billingAddress?AddressStorePayload | null
billingAddressId?SubblyCart["billingAddressId"]
couponCode?SubblyCart["couponCode"]
currencyCode?SubblyCart["currencyCode"]
customer?CartCustomerData | null
giftCardCode?SubblyCart["giftCardCode"]
giftInfo?SubblyCart["giftInfo"] | null
paymentMethodId?SubblyCart["paymentMethodId"]
pickupInfo?PickupInfoStorePayload | null
referralId?ID | null
shippingAddress?AddressStorePayload | null
shippingAddressId?SubblyCart["shippingAddressId"]
shippingMethodId?SubblyCart["shippingMethodId"]

CheckoutPurchasePayload

CheckoutPurchasePayload: Object

Type declaration

NameType
paymentIntentId?string | null
paymentMethodId?PaymentMethod["id"]

CheckoutPurchaseResponse

CheckoutPurchaseResponse: Object

Type declaration

NameType
invoicePurchaseInvoice | null
ordersPurchaseOrder[] | null
subscriptionPurchaseSubscription | null

Country

Country: Object

Type declaration

NameType
codestring
codeIso3string
idID
namestring
regionTitlestring
regionsCountryRegion[]
scaRequiredboolean

CountryRegion

CountryRegion: Object

Type declaration

NameType
codestring
idID
namestring

Coupon

Coupon: Object

A coupon object

Type declaration

NameType
amountOffnumber | null
couponIdstring
duration"once" | "forever" | "multiple"
durationInMonthsnumber | null
idID
namestring
percentOffnumber | null

CustomerAddress

CustomerAddress: Object

Customer shipping address object

Example

const address = {
  addressOne: '123 Main St',
  addressTwo: null,
  city: 'New York',
  country: 'United States',
  countryCode: 'US',
  countryId: 230,
  firstName: 'John',
  id: 111,
  lastName: 'Doe',
  phone: '+15105829395',
  regionId: 2472,
  zip: '12992'
}

Type declaration

NameType
addressOnestring
addressTwostring | null
citystring
countrystring
countryCodestring
countryIdCountry["id"]
firstNamestring
idID
lastNamestring
phonestring
regionstring
regionIdCountryRegion["id"] | null
zipstring

CustomerPickupInfo

CustomerPickupInfo: Object

Type declaration

NameType
firstNamestring
idID
lastNamestring
phonestring
pickupPointExternalPickupPoint | null

CustomerUpdatePayload

CustomerUpdatePayload: Object

Type declaration

NameType
externalId?string | null
firstName?string
lastName?string
marketingConsent?boolean
tosConsent?boolean

ExternalPickupPoint

ExternalPickupPoint: Object

Type declaration

NameType
addressOnestring
addressTwostring
citystring
countryCodeCountry["code"]
countryIdCountry["id"]
createdAtstring
externalIdstring
idID
typemondialRelay
updatedAtstring
zipstring

FunnelAcceptPayload

FunnelAcceptPayload: Object

Type declaration

NameType
offersFunnelOfferPayload[]

FunnelFetchResponse

FunnelFetchResponse: Object

Type declaration

NameType
stepFunnelStep | null

FunnelOffer

FunnelOffer: Object

Type declaration

NameType
amountOffnumber | null
percentOffnumber | null
productsProduct[]
typeFunnelOfferType

FunnelOfferPayload

FunnelOfferPayload: Object

Type declaration

NameType
options?SubscriptionSurveyOption[]
productIdProduct["id"]

FunnelOfferType

FunnelOfferType: "single" | "multiple" | "one_click"


FunnelPostAcceptPayload

FunnelPostAcceptPayload: Object

Type declaration

NameType
offersFunnelOfferPayload[]
paymentIntentId?string | null
shippingAddressId?SubblyCart["shippingAddressId"]
shippingMethodId?SubblyCart["shippingMethodId"]

FunnelPostAcceptResponse

FunnelPostAcceptResponse: CheckoutPurchaseResponse


FunnelStep

FunnelStep: Object

Type declaration

NameType
addonboolean
addonDurationnumber | null
descriptionstring | null
externalUrl?string | null
idID
initialboolean
offerFunnelOffer
skipAnsweredSurvey?boolean
titlestring
typeFunnelType

FunnelType

FunnelType: "funnel_pre_purchase" | "funnel_mid_purchase" | "funnel_post_purchase" | "funnel_post_purchase_complete"


FunnelsExpandableProperties

FunnelsExpandableProperties: "parent" | string


FunnelsResourceParams

FunnelsResourceParams: Object

Type declaration

NameType
expandFunnelsExpandableProperties[]

GatewayConnectableAuthNet

GatewayConnectableAuthNet: Object

Type declaration

NameType
apiLoginIdstring
publicKeystring

GatewayConnectableBraintree

GatewayConnectableBraintree: Object

Type declaration

NameType
authorizeKeystring
paypalboolean

GatewayConnectablePayPal

GatewayConnectablePayPal: Object

Type declaration

NameType
clientIdstring

GatewayConnectableStripe

GatewayConnectableStripe: Object

Type declaration

NameType
isoCountryCodestring | null
publishableKeystring

GiftCard

GiftCard: Object

A gift card object

Type declaration

NameType
amountnumber
balancenumber
codestring
idID
messagestring
statusGiftCardStatus

GiftCardRecipient

GiftCardRecipient: Object

Type declaration

NameType
customerEmailstring | null
customerNamestring | null
messagestring | null

GiftCardStatus

GiftCardStatus: "issued" | "redeemed" | "partially_used" | "used" | "cancelled" | "expired"


ID

ID: number


InvoiceItem

InvoiceItem: Object

Type declaration

NameType
addonIdID | null
amountnumber
createdAtstring
descriptionstring
digitalfalse
discountAmount0
giftCardGiftCardRecipient | null
idID
productIdProduct["id"]
quantitynumber
subscriptionIdID | null
surveynull
taxAmount578
taxInclusivetrue
taxRatenumber
typeCartSummaryItemType
updatedAtstring

LeadSubscribePayload

LeadSubscribePayload: Object

Type declaration

NameType
emailstring
firstName?string | null
lastName?string | null

LeadSubscribeResponse

LeadSubscribeResponse: Object

Type declaration

NameType
emailstring
firstNamestring | null
idID
ipAddressstring
lastNamestring | null
userAgentstring

LocalDelivery

LocalDelivery: Object

Type declaration

NameType
commentstring | null
durationstring
namestring

Pagination

Pagination: Object

Type declaration

NameType
currentPagenumber
fromnumber
lastPagenumber
tonumber
totalnumber

ParentProduct

ParentProduct: ProductSubscription | ProductOneTime


PaymentIntentResponse

PaymentIntentResponse: Object

Type declaration

NameType
amountnumber
createdAtstring
currencyCodestring
idstring
invoiceIdID
paymentMethodIdPaymentMethod["id"]
status"requires_confirmation" | string
tokenstring
updatedAtstring

PaymentMethod

PaymentMethod: Object

Type declaration

NameType
acssDebitPaymentMethodAcssDebit | null
bancontactPaymentMethodBancontact | null
cardPaymentMethodCard | null
cashappPaymentMethodCashapp | null
idID
idealPaymentMethodIdeal | null
identifierstring
linkPaymentMethodLink | null
sepaDebitPaymentMethodSepaDebit | null
sofortPaymentMethodSofort | null
typePaymentMethodType
usBankAccount?PaymentMethodUsBankAccount | null

PaymentMethodAcssDebit

PaymentMethodAcssDebit: Object

Type declaration

NameType
bankNamestring
emailstring
institutionNumberstring
lastFourstring
namestring
transitNumberstring

PaymentMethodBancontact

PaymentMethodBancontact: Object

Type declaration

NameType
emailstring
namestring

PaymentMethodCard

PaymentMethodCard: Object

Type declaration

NameType
brand"visa" | "mastercard" | string
expiryMonthstring
expiryYearstring
last4string
typestring

PaymentMethodCashapp

PaymentMethodCashapp: Object

Type declaration

NameType
buyerIdstring
cashTagstring
emailstring
namestring

PaymentMethodIdeal

PaymentMethodIdeal: Object

Type declaration

NameType
bank"revolut" | string
bicstring
emailstring
namestring

PaymentMethodLink: Object

Type declaration

NameType
emailstring
namestring

PaymentMethodSepaDebit

PaymentMethodSepaDebit: Object

Type declaration

NameType
bank_codestring
branch_codestring
countrystring
emailstring
ibanLast4string
namestring

PaymentMethodSofort

PaymentMethodSofort: Object

Type declaration

NameType
countrystring
emailstring
namestring

PaymentMethodStorePayload

PaymentMethodStorePayload: Object

Type declaration

NameType
gatewayIdShopGateway["id"]
tokenstring

PaymentMethodType

PaymentMethodType: "card" | "paypal" | "us_bank_account" | "bancontact" | "sofort" | "ideal" | "cashapp" | "link" | "sepa_debit" | "acss_debit"


PaymentMethodUsBankAccount

PaymentMethodUsBankAccount: Object

Type declaration

NameType
accountHolderType"company" | "individual" | string
accountType"checking" | "savings" | string
bankNamestring
emailstring
last4string
namestring
routingNumberstring

PickupInfoFetchParams

PickupInfoFetchParams: Object

Type declaration

NameType
shippingMethodId?ShippingMethodPickup["id"]

PickupInfoStorePayload

PickupInfoStorePayload: Object

Type declaration

NameType
firstNameCustomerPickupInfo["firstName"]
lastNameCustomerPickupInfo["lastName"]
phoneCustomerPickupInfo["phone"]
pickupPointId?string
pickupPointType?mondialRelay

PickupPoint

PickupPoint: Object

Type declaration

NameType
addressOnestring
addressTwostring | null
citystring
commentstring
countrystring
countryCode?string
idID
namestring
phonestring
pricenumber
regionstring
typePickupPointType
workingHoursstring
zipstring

PriceSchemeRange

PriceSchemeRange: Object

Type declaration

NameType
amountnumber
idID
rangenumber

Product

Product: ProductPricing | ProductVariant


ProductBase

ProductBase: Object

Type declaration

NameType
bundleBundle | null
bundleIdBundle["id"] | null
bundleRulesetIdBundleRuleset["id"] | null
collectShippingAddressboolean
createdAtstring
deliveryInfostring | null
descriptionstring | null
digitalboolean
giftingEnabledboolean
idID
imagesProductImage[]
namestring
slugstring

ProductImage

ProductImage: Object

Type declaration

NameType
createdAtstring
idID
ordernumber
updatedAtstring
urlstring

ProductOneTime

ProductOneTime: ProductBase & { giftCard: boolean ; giftCardExpiration: number | null ; type: oneTime ; variants: ProductVariant[] }


ProductPriceScheme

ProductPriceScheme: Object

Type declaration

NameType
idID
rangesPriceSchemeRange[]
type"volume_price" | string

ProductPricing

ProductPricing: Object

Type declaration

NameType
bundlePlanIdBundlePlan["id"] | null
chargeImmediatelyboolean
chargesLimitnumber | null
commitmentBillingCountnumber
createdAtstring
cutOffAtstring | null
descriptionstring | null
frequencyCountnumber
frequencyUnitFrequencyUnit
idnumber
namestring
parentProductSubscription
pricenumber
priceSchemeProductPriceScheme | null
pricingNamestring | null
rebillingStartAtstring | null
shipImmediatelyboolean
shippingsProductShipping[]
stockCountnumber | null
surveySurvey | null
trialLengthnumber | null
trialPricenumber | null

ProductRequestHeaders

ProductRequestHeaders: RequestHeaders & { x-currency?: string }


ProductShipping

ProductShipping: Object

Type declaration

NameType
addCountnumber | null
addUnitFrequencyUnit
createdAtstring
idID
shippingAtstring | null
updatedAtstring

ProductSubscription

ProductSubscription: ProductBase & { preOrderEndAt: string \| null ; pricings: ProductPricing[] ; setupFee: number ; type: subscription }


ProductUnknown

ProductUnknown: Product | ParentProduct


ProductVariant

ProductVariant: Object

Type declaration

NameType
bundlePlanIdBundlePlan["id"] | null
createdAtstring
descriptionstring | null
idID
namestring
optionsProductVariantOption[]
parentProductOneTime
pricenumber
priceSchemeProductPriceScheme | null
stockCountnumber | null

ProductVariantOption

ProductVariantOption: Object

Type declaration

NameType
idID
namestring
valuestring

ProductsExpandableProperties

ProductsExpandableProperties: "variants" | "pricings" | "pricings.parent" | "variants.parent" | string


ProductsListParams

ProductsListParams: Object

Type declaration

NameType
expand?ProductsExpandableProperties[]
page?number
perPage?number

ProductsListResponse

ProductsListResponse: Object

Type declaration

NameType
dataParentProduct[]
paginationPagination

ProductsResourceParams

ProductsResourceParams: Object

Type declaration

NameType
expand?ProductsExpandableProperties[]

PurchaseExpandProperty

PurchaseExpandProperty: "subscription.product" | "subscription.product.parent" | "subscription.product.parent.bundle" | string


PurchaseInvoice

PurchaseInvoice: Object

Type declaration

NameType
adjustmentnumber
billingAddressIdCustomerAddress["id"] | null
createdAtstring
currencyCodestring
customerIdSubblyCustomer["id"]
descriptionstring
discountsunknown[]
discountsAmountnumber
firstShipmentAtstring | null
idID
itemsInvoiceItem[]
paid_atstring | null
periodEndstring | null
periodStartstring | null
shippingAddressIdCustomerAddress["id"] | null
shippingMethodIdShippingMethod["id"] | null
status"paid" | string
subTotalnumber
taxAmountnumber
totalnumber
updatedAtstring

PurchaseOrder

PurchaseOrder: Object

Type declaration

NameType
adjustmentnumber
created_atstring
currencyCodestring
customerIdSubblyCustomer["id"]
discounts[]
dueDatestring | null
giftnull
idID
invoiceIdPurchaseInvoice["id"]
itemsunknown[]
shippingAddressIdCustomerAddress["id"] | null
shippingItemsunknown[]
shippingMethodIdShippingMethod["id"] | null
status"Awaiting Delivery" | string
subTotal4468
subscriptionIdPurchaseSubscription["id"] | null
taxAmountnumber
totalnumber
updatedAtstring

PurchaseRequestParams

PurchaseRequestParams: Object

Type declaration

NameType
expand?PurchaseExpandProperty[]

PurchaseSubscription

PurchaseSubscription: Object

Type declaration

NameType
addonsunknown[]
billingAddressIdCustomerAddress["id"] | null
cancelAtEndOfCommitmentboolean
cancellationsunknown[]
commitmentTermTotalPaymentsnumber
createdAtstring
currencyCodestring
customerIdSubblyCustomer["id"]
discountsunknown[]
giftunknown
idID
lastPaymentAtstring | null
nextPaymentDatestring
paymentMethodIdPaymentMethod["id"]
productIdProduct["id"]
referredByID | null
shippingAddressIdCustomerAddress["id"] | CustomerPickupInfo["id"] | null
shippingMethodIdShippingMethod["id"] | null
status"active" | string
surveySubscriptionSurvey | null
updatedAtstring

ShippingMethod

ShippingMethod: ShippingMethodDelivery | ShippingMethodPickup


ShippingMethodDelivery

ShippingMethodDelivery: ShippingMethodShippingOption | ShippingMethodLocalDelivery


ShippingMethodLocalDelivery

ShippingMethodLocalDelivery: Object

Type declaration

NameType
futureShippingFeenumber
idID
methodLocalDelivery
shippingFeenumber
type"local_delivery"

ShippingMethodPickup

ShippingMethodPickup: Object

Pick-up point shipping method

Type declaration

NameType
futureShippingFeenumber
idID
methodPickupPoint
shippingFeenumber
type"local_pickup"

ShippingMethodShippingOption

ShippingMethodShippingOption: Object

Type declaration

NameType
futureShippingFeenumber
idID
methodShippingOption
shippingFeenumber
type"shipping_option"

ShippingOption

ShippingOption: Object

Type declaration

NameType
durationnull
namestring
type"flat_price" | "product" | "price" | "weight"

ShopApp

ShopApp: Object

Type declaration

NameType
propertiesRecord<string, string | number | boolean>
typeShopAppType

ShopAppType

type ShopAppType = 'ga' | 'google_tag' | 'facebook_pixel' | 'google_login' | 'facebook_login' | string 

ShopBranding

ShopBranding: Object

Type declaration

NameType
brandColourstring | null
faviconstring | null
logoSquarestring | null

ShopCartSettings

ShopCartSettings: Object

Type declaration

NameType
accentColorstring | null
afterItemAddednotify | summary | checkout | null
backgroundColorstring | null
buttonStylenumber | null
cardBackgroundColorstring | null
cardBorderColorstring | null
cardDividerColorstring | null
cardStylenumber | null
checkoutLayoutOneStepboolean
fontColorPrimarystring | null
fontColorSecondarystring | null
fontStylestring | null
footerBackgroundstring | null
footerFontColorstring | null
headerBackgroundColorstring | null
headerFontColorstring | null
headerHeightnumber | null
hidePricingPriceboolean
inputBackgroundstring | null
inputBorderColorstring | null
inputFontColorstring | null
itemAddedScreenboolean
localizationSettingsboolean
segmentControlBackgroundstring | null
widgetBackgroundColorstring | null
widgetBackgroundDarkerstring | null
widgetView"pop-up" | "fullscreen"

ShopCountry

ShopCountry: Object

Type declaration

NameType
codestring
currencyCodestring
idID
namestring

ShopCurrency

ShopCurrency: Object

Type declaration

NameType
abbreviationstring
gatewaysShopGateway[]
htmlstring
namestring
symbolstring

ShopGateway

ShopGateway: ShopGatewayStripe | ShopGatewayBraintree | ShopGatewayPayPal | ShopGatewayAuthNet


ShopGatewayAuthNet

ShopGatewayAuthNet: Object

Type declaration

NameType
connectableGatewayConnectableAuthNet
idID
nameauthorizeNet
typecard

ShopGatewayBraintree

ShopGatewayBraintree: Object

Type declaration

NameType
connectableGatewayConnectableBraintree
idID
namebraintree
typecard | paypal

ShopGatewayPayPal

ShopGatewayPayPal: Object

Type declaration

NameType
connectableGatewayConnectablePayPal
idID
namepaypal
typepaypal

ShopGatewayStripe

ShopGatewayStripe: Object

Type declaration

NameType
connectableGatewayConnectableStripe
idID
namestripe
typecard

ShopLanguage

ShopLanguage: Object

Type declaration

NameType
codestring
currencyPositionnumber | 1 | 0
dictionaryRecord<string, string>
namestring
primaryboolean
publishedboolean

ShopLimits

ShopLimits: Object

Type declaration

NameType
checkoutWidgetboolean
configurableBundlesboolean
embedCheckoutboolean
outOfStockboolean
whiteLabelingboolean

ShopReferralSettings

ShopReferralSettings: Object

Type declaration

NameType
enabledboolean
refereeDiscountnumber
referralDiscountnumber

ShopSettings

ShopSettings: Object

Type declaration

NameType
allowCouponDiscountboolean
allowGiftCardDiscountboolean
applePayboolean
collectBillingAddressboolean
collectBuyerNameboolean
collectGiftRecipientEmailboolean
displayCommitmentAndTrialboolean
facebookConversionEnabledboolean
giftDurationEnabledboolean
giftStartDateEnabledboolean
googlePayboolean
limitCouponAndReferralDiscountboolean
localPickupOnlyboolean
marketingConsentRequiredboolean
outOfStockEnabledboolean
phoneNumberOptionalboolean
registerWithoutPasswordboolean
scaEnabledboolean
skipPaymentMethodWithGiftCardboolean
subscriptionAddonsboolean
subscriptionQuantitySelectorboolean
taxEnabledboolean
taxInclusiveboolean
timezonestring | null
tosConsentRequiredboolean
zeroChargeNotificationboolean

StockSubscriptionPayload

StockSubscriptionPayload: Object

Type declaration

NameType
answerId?ID
emailstring
productId?ID
quantity?number

StockSubscriptionResponse

StockSubscriptionResponse: Object

Type declaration

NameType
createdAtstring
emailstring
entityIdID
entityType"product" | "survey_answer"
idID
inStockAtstring
productIdID
quantitynumber
shopIdID
updatedAtstring

SubblyCart

SubblyCart: Object

Subbly cart contains all the customer's order progress information

Type declaration

NameType
adjustmentnumber
attachedboolean
balanceChangeCartBalanceChange
baseCurrencyCodestring
billingAddressCustomerAddress | null
billingAddressIdCustomerAddress["id"] | null
coupon?Coupon | null
couponCodestring | null
createdAtstring
currencyCodestring
customerIdSubblyCustomer["id"] | null
discountTotalnumber
discountsCartDiscount[]
futureShippingFeenumber
giftCard?GiftCard | null
giftCardCodestring | null
giftInfoCartGiftInfo
idstring
itemsCartItem[]
paymentMethodPaymentMethod | null
paymentMethodIdPaymentMethod["id"] | null
referralIdID | null
shippingAddressCustomerAddress | CustomerPickupInfo | null
shippingAddressIdCustomerAddress["id"] | CustomerPickupInfo["id"] | null
shippingMethodShippingMethod | null
shippingMethodIdShippingMethod["id"] | null
shopIdID
statusCartStatus
subTotalnumber
summaryItemsCartSummaryItem[]
taxInclusiveboolean
taxRatenumber
taxTotalnumber
totalnumber
updatedAtstring

SubblyCustomer

SubblyCustomer: Object

Type declaration

NameType
createdAtstring
emailstring
firstNamestring
idID
lastNamestring
marketingConsentboolean
tosConsentAtstring
userIdID

SubblyError

SubblyError: SubblyErrorGeneric | SubblyErrorPurchase


SubblyErrorGeneric

SubblyErrorGeneric: Object

Type declaration

NameType
codeSubblyErrorCodes | string
messagestring

SubblyErrorPurchase

SubblyErrorPurchase: Object

Type declaration

NameType
codepaymentRequiresAction
messagestring
paymentIntentId?string

SubblyShop

SubblyShop: Object

Type declaration

NameType
appsShopApp[]
brandingShopBranding
cartSettingsShopCartSettings
checkoutJsstring | null
checkoutUrlstring
conversionTrackingCodestring | null
countryShopCountry
currenciesShopCurrency[]
languagesShopLanguage[]
limitsShopLimits
localPickupOnlyboolean
namestring
referralSettingsShopReferralSettings | null
settingsShopSettings
shippingCountriesCountry[]
shopIdID
slugstring
statusboolean
supportEmailstring
supportUrlstring
termsAndConditionsstring
urlstring

Subscription

Subscription: Object

Type declaration

NameType
addonsSubscriptionAddon[]
billingAddressIdCustomerAddress["id"] | null
bundleSubscriptionBundle | null
cancelAtEndOfCommitmentboolean
cancellationsSubscriptionCancellation[]
chargesLimitnumber | null
commitmentTermTotalPaymentsnumber | null
createdAtstring
currency_codestring
customerIdSubblyCustomer["id"]
discountsSubscriptionDiscount
expiredAtstring | null
giftSubscriptionGift | null
idID
lastPaymentAtstring | null
nextPaymentDatestring
paymentMethodIdPaymentMethod["id"]
productProductPricing
productIdID
quantitynumber
referredByID | null
shippingAddressIdCustomerAddress["id"] | CustomerPickupInfo["id"] | null
shippingMethodIdShippingMethod["id"] | null
statusSubscriptionStatus
surveySubscriptionSurvey | null
updatedAtstring

SubscriptionAddon

SubscriptionAddon: Object

Type declaration

NameType
createdAtstring
discountsSubscriptionDiscount[]
durationnumber
idID
productProductVariant | null
productIdProductVariant["id"]
quantitynumber
subscriptionIdSubscription["id"]
updatedAtstring

SubscriptionBundle

SubscriptionBundle: Object

Type declaration

NameType
itemsBundleItem[]
preferencesCartItemBundlePreference[]

SubscriptionBundlePayload

SubscriptionBundlePayload: Object

Type declaration

NameType
bundle{ items: BundlePayloadItem[] | null ; preferences: BundlePayloadPreference[] | null }
bundle.itemsBundlePayloadItem[] | null
bundle.preferencesBundlePayloadPreference[] | null
productIdProduct["id"] | null
quantitynumber | null

SubscriptionCancellation

SubscriptionCancellation: Object

Type declaration

NameType
createdAtstring
endstring | null
extraFeedbackstring | null
idID
reasonstring | null
reasonSubmittedOnstring | null
startstring
subscriptionIdSubscription["id"]
updatedAtstring

SubscriptionDiscount

SubscriptionDiscount: Object

Type declaration

NameType
amountOffnumber | null
couponIdCoupon["id"] | null
createdAtstring
customerIdSubblyCustomer["id"]
endstring | null
idID
percentOffnumber | null
startstring | null
updatedAtstring

SubscriptionGift

SubscriptionGift: Object

Type declaration

NameType
messagestring | null
orderLimitnumber | null
startsAtstring | null

SubscriptionPreferencesPayload

SubscriptionPreferencesPayload: Object

Type declaration

NameType
preferencesSubscriptionSurveyOption[] | null
updateOrdersboolean

SubscriptionStatus

SubscriptionStatus: "active" | "trial" | "pre_order" | "gift_waiting_to_start" | "cancelled" | "switched" | "expired"


SubscriptionSurvey

SubscriptionSurvey: Object

Answered subscription survey

Type declaration

NameType
dataSubscriptionSurveyOption[]
surveyIdSurvey["id"]

SubscriptionSurveyOption

SubscriptionSurveyOption: Object

Subscription survey option containing answers

Type declaration

NameType
answersSubscriptionSurveyOptionAnswer[]
questionIdID

SubscriptionSurveyOptionAnswer

SubscriptionSurveyOptionAnswer: SurveyOptionAnswerText | SurveyOptionAnswerSelect | SurveyOptionAnswerMultiple | SurveyOptionAnswerQuantity | SurveyOptionAnswerPlan | SurveyOptionAnswerOffer | SurveyOptionAnswerEmail

Subscription survey option answer


SubscriptionUpdatePayload

SubscriptionUpdatePayload: Object

Type declaration

NameType
quantitynumber

SubscriptionsExpandProps

SubscriptionsExpandProps: "product" | "product.parent" | "bundle.items.product" | "bundle.items.product.parent" | string


SubscriptionsResourceParams

SubscriptionsResourceParams: Object

Type declaration

NameType
expandSubscriptionsExpandProps[]

SummaryBundleItem

SummaryBundleItem: Object

Type declaration

NameType
discountnumber | null
idCartItem["id"]
pricenumber
productIdProductOneTime["id"]
quantitynumber
subTotalnumber
taxAmountnumber
taxInclusiveboolean
taxRatenumber
totalnumber

SummarySubscriptionItemInfo

SummarySubscriptionItemInfo: Object

Type declaration

NameType
firstPaymentAtstring | null
firstShipmentAtstring | null
nextPaymentAtstring | null
numberOfShipmentsnumber | null

Survey

Survey: Object

Type declaration

NameType
appearanceTypeSurveyAppearanceType
customizationsSurveyCustomizations
idnumber
multiplyPriceByShipmentNumberboolean
questionsSurveyQuestion[]
titlestring

SurveyAnswer

SurveyAnswer: SurveyAnswerSelect | SurveyAnswerMultiple | SurveyAnswerQuantity | SurveyAnswerPlan | SurveyAnswerOffer


SurveyAnswerMultiple

SurveyAnswerMultiple: Object

Type declaration

NameType
contentstring | null
createdAtstring
customizationsnull
defaultboolean
descriptionstring | null
idID
imageUrlstring | null
positionnumber
pricenumber
stockCountstring | null
updatedAtstring

SurveyAnswerOffer

SurveyAnswerOffer: Object

Type declaration

NameType
contentstring | null
createdAtstring
customizationsAnswerOfferCustomizations
descriptionstring | null
idID
imageUrlstring | null
positionnumber
pricenumber
productProduct | null
productIdProductVariant["id"] | null
updatedAtstring

SurveyAnswerPlan

SurveyAnswerPlan: Object

Type declaration

NameType
contentstring | null
createdAtstring
customizationsAnswerPlanCustomizations
defaultboolean
descriptionstring | null
idID
imageUrlstring | null
positionnumber
pricenumber
productProduct | null
productIdProductVariant["id"] | null
updatedAtstring

SurveyAnswerQuantity

SurveyAnswerQuantity: Object

Type declaration

NameType
contentstring | null
createdAtstring
customizationsnull
defaultQuantitynumber
descriptionstring | null
idID
imageUrlstring | null
positionnumber
pricenumber
stockCountnumber | null
updatedAtstring

SurveyAnswerSelect

SurveyAnswerSelect: Object

Type declaration

NameType
contentstring | null
createdAtstring
customizationsnull
defaultboolean
descriptionstring | null
idID
imageUrlstring | null
positionnumber
pricenumber
stockCountnumber | null
updatedAtstring

SurveyCustomizations

SurveyCustomizations: Object

Type declaration

NameType
progressTypeSurveyProgressType

SurveyExpandableProperties

SurveyExpandableProperties: "questions.answers.product.parent" | string


SurveyOptionAnswerEmail

SurveyOptionAnswerEmail: Object

Type declaration

NameType
contentstring

SurveyOptionAnswerMultiple

SurveyOptionAnswerMultiple: Object

Survey multiple option type answer

Type declaration

NameType
idID

SurveyOptionAnswerOffer

SurveyOptionAnswerOffer: Object

Survey offer type answer object

Type declaration

NameType
idID

SurveyOptionAnswerPlan

SurveyOptionAnswerPlan: Object

Survey plan type answer object

Type declaration

NameType
idID

SurveyOptionAnswerQuantity

SurveyOptionAnswerQuantity: Object

Survey quantity option type answer

Type declaration

NameType
idID
quantitynumber

SurveyOptionAnswerSelect

SurveyOptionAnswerSelect: Object

Survey select type answer object

Type declaration

NameType
idID

SurveyOptionAnswerText

SurveyOptionAnswerText: Object

Type declaration

NameType
contentstring

SurveyProgressType

SurveyProgressType: "steps" | "dots" | "bar"


SurveyQuestion

SurveyQuestion: SurveyQuestionOffer | SurveyQuestionQuantity | SurveyQuestionMultiple | SurveyQuestionSelect | SurveyQuestionText | SurveyQuestionEmail | SurveyQuestionPlan


SurveyQuestionMultiple

SurveyQuestionMultiple: Object

Type declaration

NameType
answersSurveyAnswerMultiple[]
createdAtstring
customizationsQuestionMultipleCustomizations
descriptionstring | null
idID
maxAmountnumber | null
maxCountnumber | null
minAmountnumber | null
minCountnumber | null
positionnumber
requiredboolean
titlestring
typemultiple
updatedAtstring

SurveyQuestionOffer

SurveyQuestionOffer: Object

Type declaration

NameType
answersSurveyAnswerOffer[]
createdAtstring
customizationsnull
descriptionstring | null
idID
positionnumber
requiredboolean
titlestring
typeoffer
updatedAtstring

SurveyQuestionPlan

SurveyQuestionPlan: Object

Type declaration

NameType
answersSurveyAnswerPlan[]
createdAtstring
customizationsQuestionPlanCustomizations
descriptionstring | null
idID
positionnumber
requiredboolean
titlestring
typeplan
updatedAtstring

SurveyQuestionQuantity

SurveyQuestionQuantity: Object

Type declaration

NameType
answersSurveyAnswerQuantity[]
createdAtstring
customizationsnull
descriptionstring | null
idID
maxAmountnumber | null
maxCountnumber | null
minAmountnumber | null
minCountnumber | null
positionnumber
requiredboolean
titlestring
typequantity
updatedAtstring

SurveyQuestionSelect

SurveyQuestionSelect: Object

Type declaration

NameType
answersSurveyAnswerSelect[]
createdAtstring
customizationsQuestionSelectCustomizations
descriptionstring | null
idID
positionnumber
requiredboolean
titlestring
typeselect
updatedAtstring

SurveyQuestionText

SurveyQuestionText: Object

Type declaration

NameType
answersnever[]
createdAtstring
customizationsQuestionTextCustomizations
descriptionstring | null
idID
positionnumber
requiredboolean
titlestring
typetext
updatedAtstring

SurveyRequestHeaders

SurveyRequestHeaders: RequestHeaders & { x-currency?: string }


SurveyResourceParams

SurveyResourceParams: Object

Type declaration

NameType
expand?SurveyExpandableProperties[]

WalletSetupIntentPayload

WalletSetupIntentPayload: Object

Type declaration

NameType
gatewayIdShopGateway["id"]
redirectUrlstring

WalletSetupIntentResponse

WalletSetupIntentResponse: Object

Type declaration

NameType
expiresAtstring
idstring
redirectUrlstring
subblyUrlstring

WalletSetupPayload

WalletSetupPayload: Object

Type declaration

NameType
gatewayIdShopGateway["id"]

WalletSetupResponse

WalletSetupResponse: Object

Type declaration

NameType
tokenstring

Enumerations

CartStatus

enum CartStatus {
  initialized = 'initialized',
  expired = 'expired',
  completed = 'completed',
  restored = 'restored'
}

CartSummaryItemType

enum CartSummaryItemType {
  oneTime = 'one_time',
  subscription = 'subscription',
  trialFirst = 'trial_first',
  giftCard = 'gift_card',
  setupFee = 'setup_fee',
  survey = 'survey',
  shipping = 'shipping',
  tax = 'tax'
}

DiscountType

enum DiscountType {
  coupon = 'coupon',
  couponGiftOffer = 'coupon_gift_offer',
  offer = 'offer',
  referral = 'referral',
  balance = 'balance',
  giftCard = 'gift_card'
}

FrequencyUnit

enum FrequencyUnit {
  day = 'day',
  week = 'week',
  month = 'month'
}

GATEWAY_NAME

enum GATEWAY_NAME {
  stripe = 'stripe',
  braintree = 'braintree',
  paypal = 'paypal',
  authorizeNet = 'authorize_net'
}

GATEWAY_TYPE

enum GATEWAY_TYPE {
  card = 'card',
  paypal = 'paypal'
}

PickupPointType

enum PickupPointType {
  pickup = 'pickup',
  mondialRelay = 'mondial_relay'
}

ProductType

enum ProductType {
  oneTime = 'one_time',
  subscription = 'subscription'
}

SubblyErrorCodes

enum SubblyErrorCodes {
  notFound = 'not_found',
  badRequest = 'bad_request',
  outOfStock = 'out_of_stock',
  paymentRequiresAction = 'payment_requires_action',
  userEmailIsNotUnique = 'user_email_is_not_unique',
  unauthenticated = 'unauthenticated'
}

SurveyAppearanceType

enum SurveyAppearanceType {
  beforeCart = 'before_cart',
  afterCheckout = 'after_checkout',
  subscriptionBox = 'subscription_box'
}

SurveyQuestionType

enum SurveyQuestionType {
  text = 'text',
  select = 'select',
  multiple = 'multiple',
  quantity = 'quantity',
  offer = 'offer',
  plan = 'plan',
  email = 'email'
}