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
Name | Type |
---|---|
addressOne | string |
addressTwo | string | null |
city | string |
countryId | ID |
firstName | string |
lastName | string |
phone? | string |
region? | string |
regionId? | ID |
zip | string |
AttributeValue
AttributeValue: Object
Type declaration
Name | Type |
---|---|
id | ID |
name | string |
AuthResourceLoginPayload
AuthResourceLoginPayload: Object
Sign-in request payload
Type declaration
Name | Type |
---|---|
email | string |
password | string |
AuthResourceLoginResponse
AuthResourceLoginResponse: Object
Successful client authentication response
Type declaration
Name | Type |
---|---|
accessToken | string |
expiresIn | number |
AuthResourceOtpLoginPayload
AuthResourceOtpLoginPayload: Object
OTP sign-in request payload
Type declaration
Name | Type |
---|---|
email | string |
token | string |
AuthResourceOtpPayload
AuthResourceOtpPayload: Object
OTP request payload
Type declaration
Name | Type |
---|---|
email | string |
AuthResourceRegisterPayload
AuthResourceRegisterPayload: Object
User registration payload
Example
const payload = {
email: '[email protected]',
firstName: 'John',
lastName: 'Doe'
}
Type declaration
Name | Type |
---|---|
email | string |
firstName | string |
lastName | string |
password? | string |
AuthResourceRegisteredPayload
AuthResourceRegisteredPayload: Object
Email registered request payload
Type declaration
Name | Type |
---|---|
email | string |
AuthResourceRegisteredResponse
AuthResourceRegisteredResponse: Object
Email registered response
Type declaration
Name | Type |
---|---|
registered | boolean |
AuthResourceSocialPayload
AuthResourceSocialPayload: Object
SSO sign-in payload
Type declaration
Name | Type |
---|---|
provider | "google" | "facebook" |
token | string |
Bundle
Bundle: Object
Type declaration
Name | Type |
---|---|
appearanceType | BundleAppearanceType |
configurable | boolean |
createdAt | string |
description | string | null |
discountType | BundleDiscountType | null |
discounts | BundleDiscount [] |
filters | BundleFilter [] |
hiddenItems | boolean |
id | ID |
name | string |
plans | BundlePlan [] |
preferences | BundlePreference [] |
priceType | BundlePriceType | null |
quantitySelectors | BundleQuantitySelector [] | null |
rulesets | BundleRuleset [] |
updatedAt | string |
BundleAppearanceType
BundleAppearanceType: "one_step"
| "two_step"
| "without_ruleset"
| "after_checkout"
BundleDiscount
BundleDiscount: Object
Type declaration
Name | Type |
---|---|
createdAt | string |
id | ID |
planId | ID |
ranges | BundleDiscountRange [] |
rulesetId | ID |
updatedAt | string |
BundleDiscountRange
BundleDiscountRange: Object
Type declaration
Name | Type |
---|---|
amountOff | number | null |
percentOff | number | null |
range | number |
BundleDiscountType
BundleDiscountType: "per_item"
| "total"
| "percentage"
BundleExpandProperty
BundleExpandProperty: "plans.variants"
| "plans.pricings"
| "plans.variants.parent"
| "plans.pricings.parent"
| string
BundleFilter
BundleFilter: Object
Type declaration
Name | Type |
---|---|
attributeId | ID |
createdAt | string |
id | ID |
name | string |
updatedAt | string |
values | AttributeValue [] |
BundleItem
BundleItem: Object
Type declaration
Name | Type |
---|---|
createdAt | string |
extraPrice | number |
id | ID |
position | number |
product | ProductVariant |
productId | ProductVariant ["id" ] |
quantity | number |
settings | BundleItemSettings [] |
updatedAt | string |
stockCount | `number |
BundleItemExpandProperty
BundleItemExpandProperty: "product"
| "product.parent"
| string
BundleItemSettings
BundleItemSettings: Object
Type declaration
Name | Type |
---|---|
createdAt | string |
id | ID |
maxQuantity | number |
rulesetId | ID |
updatedAt | string |
BundleItemsParamFilter
BundleItemsParamFilter: Object
Type declaration
Name | Type |
---|---|
attributeId | ID |
values | ID [] |
BundleItemsParams
BundleItemsParams: Object
Type declaration
Name | Type |
---|---|
expand? | BundleItemExpandProperty [] |
filters? | BundleItemsParamFilter [] |
page? | number |
perPage? | number |
productIds? | ProductVariant ["id" ][] |
BundleItemsResponse
BundleItemsResponse: Object
Type declaration
Name | Type |
---|---|
data | BundleItem [] |
pagination | Pagination |
BundlePayloadItem
BundlePayloadItem: Object
Type declaration
Name | Type |
---|---|
productId | ID |
quantity | number |
BundlePayloadPreference
BundlePayloadPreference: Object
Type declaration
Name | Type |
---|---|
attributeId | ID |
values | ID [] |
BundlePlan
BundlePlan: Object
Type declaration
Name | Type |
---|---|
id | ID |
pricings | ProductPricing [] | null |
variants | ProductVariant [] | null |
BundlePreference
BundlePreference: Object
Type declaration
Name | Type |
---|---|
attributeId | ID |
createdAt | string |
id | ID |
title | string |
updatedAt | string |
values | AttributeValue [] |
BundlePriceType
BundlePriceType: "per_item"
| "total"
BundleQuantitySelector
BundleQuantitySelector: number
BundleQuote
BundleQuote: Object
Type declaration
Name | Type |
---|---|
discount | number |
items | BundleQuoteItem [] |
price | number |
product | Product |
productId | ID |
quantity | number |
subTotal | number |
taxAmount | number |
taxInclusive | number |
taxRate | number |
total | number |
BundleQuoteExpandProperty
BundleQuoteExpandProperty: "items.product"
| "items.product.parent"
| string
BundleQuoteItem
BundleQuoteItem: Object
Type declaration
Name | Type |
---|---|
discount | boolean |
price | number |
product | ProductVariant |
productId | ID |
quantity | number |
subTotal | number |
taxAmount | number |
taxInclusive | boolean |
taxRate | number |
total | number |
BundleQuoteParams
BundleQuoteParams: Object
Type declaration
Name | Type |
---|---|
expand? | BundleQuoteExpandProperty [] |
BundleQuotePayload
BundleQuotePayload: Object
Type declaration
Name | Type |
---|---|
items | BundlePayloadItem [] |
preferences | BundlePayloadPreference [] |
productId | ID |
quantity | number |
BundleRequestHeaders
BundleRequestHeaders: RequestHeaders
& { x-currency?
: string
}
BundleResourceParams
BundleResourceParams: Object
Type declaration
Name | Type |
---|---|
expand | BundleExpandProperty [] |
BundleRuleset
BundleRuleset: Object
Type declaration
Name | Type |
---|---|
createdAt | string |
ctaText | string | null |
id | ID |
maxQuantity | number |
minQuantity | number |
name | string |
products | ParentProduct [] |
updatedAt | string |
CartBalanceChange
CartBalanceChange: Object
Type declaration
Name | Type |
---|---|
amount | number |
currencyCode | string |
CartCreatePayload
CartCreatePayload: Object
Type declaration
Name | Type |
---|---|
couponCode? | SubblyCart ["couponCode" ] |
currencyCode? | SubblyCart ["currencyCode" ] |
giftCardCode? | SubblyCart ["giftCardCode" ] |
referralId? | ID | null |
CartCustomerData
CartCustomerData: Object
Type declaration
Name | Type |
---|---|
email | string |
firstName | string |
lastName | string |
marketingConsent? | boolean |
tosConsent? | boolean |
CartDiscount
CartDiscount: Object
Type declaration
Name | Type |
---|---|
chargeNow | boolean |
description | string |
total | number |
type | DiscountType |
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
Name | Type |
---|---|
message | string | null |
numberOfOrders | number | null |
recipientEmail? | string | null |
startsAt | string | null |
CartItem
CartItem: CartItemOneTime
| CartItemSubscription
CartItemAddPayload
CartItemAddPayload: CartItemAddPayloadSubscription
| CartItemAddPayloadOneTime
| CartItemAddPayloadBundle
CartItemAddPayloadBase
CartItemAddPayloadBase: Object
Type declaration
Name | Type |
---|---|
productId | number |
quantity? | number |
CartItemAddPayloadBundle
CartItemAddPayloadBundle: CartItemAddPayloadBase
& CartItemUpdatePayloadBundle
CartItemAddPayloadOneTime
CartItemAddPayloadOneTime: CartItemAddPayloadBase
& CartItemUpdatePayloadOneTime
CartItemAddPayloadSubscription
CartItemAddPayloadSubscription: CartItemAddPayloadBase
& CartItemUpdatePayloadSubscription
CartItemBase
CartItemBase: Object
Type declaration
Name | Type |
---|---|
amountOff | number | null |
chargeNow | boolean |
createdAt | string |
description | string |
discount | number |
id | string |
origin | "pre_purchase" | "mid_purchase" | "post_purchase" | null |
percentOff | number | null |
price | number |
quantity | number |
subTotal | number |
taxAmount | number |
taxInclusive | boolean |
taxRate | number |
total | number |
updatedAt | string |
CartItemBundle
CartItemBundle: Object
Type declaration
Name | Type |
---|---|
items | BundleItem [] |
preferences | CartItemBundlePreference [] |
CartItemBundlePreference
CartItemBundlePreference: Object
Type declaration
Name | Type |
---|---|
attributeId | ID |
values | ID [] |
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
Name | Type |
---|---|
firstPaymentAt | string |
firstShipmentAt | string |
nextPaymentAt | string |
numberOfShipments | 1 |
CartItemUpdatePayloadBundle
CartItemUpdatePayloadBundle: Object
Type declaration
Name | Type |
---|---|
bundle? | { items : BundlePayloadItem [] ; preferences : BundlePayloadPreference [] } |
bundle.items | BundlePayloadItem [] |
bundle.preferences | BundlePayloadPreference [] |
options? | SubscriptionSurveyOption [] | null |
quantity? | number |
CartItemUpdatePayloadOneTime
CartItemUpdatePayloadOneTime: Object
Type declaration
Name | Type |
---|---|
addon? | boolean |
addonDuration? | number | 0 | 1 |
giftCard? | GiftCardRecipient | null |
quantity? | number |
CartItemUpdatePayloadSubscription
CartItemUpdatePayloadSubscription: Object
Type declaration
Name | Type |
---|---|
options? | SubscriptionSurveyOption [] | null |
quantity? | number |
CartResourceGiftingDatesResponse
CartResourceGiftingDatesResponse: Object
Type declaration
Name | Type |
---|---|
availableDates | string [] |
range | [string , string ] |
CartResourceParams
CartResourceParams: Object
Type declaration
Name | Type |
---|---|
expand | CartExpandableProperties [] |
CartResourceUpdateItemPayload
CartResourceUpdateItemPayload: CartItemUpdatePayloadSubscription
| CartItemUpdatePayloadOneTime
| CartItemUpdatePayloadBundle
CartShippingMethodsParams
CartShippingMethodsParams: Object
Type declaration
Name | Type |
---|---|
countryId | Country ["id" ] |
regionId? | CountryRegion ["id" ] |
zip | string |
CartSummaryItem
CartSummaryItem: CartSummaryItemOneTime
| CartSummaryItemSubscription
| CartSummaryItemSetupFee
| CartSummaryItemSurvey
CartSummaryItemBase
CartSummaryItemBase: Object
Type declaration
Name | Type |
---|---|
chargeNow | boolean |
discount | number | null |
itemId | CartItem ["id" ] |
price | number |
quantity | number |
subTotal | number |
taxAmount | number |
taxInclusive | boolean |
taxRate | number |
total | number |
type | CartSummaryItemType |
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
Name | Type |
---|---|
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
Name | Type |
---|---|
paymentIntentId? | string | null |
paymentMethodId? | PaymentMethod ["id" ] |
CheckoutPurchaseResponse
CheckoutPurchaseResponse: Object
Type declaration
Name | Type |
---|---|
invoice | PurchaseInvoice | null |
orders | PurchaseOrder [] | null |
subscription | PurchaseSubscription | null |
Country
Country: Object
Type declaration
Name | Type |
---|---|
code | string |
codeIso3 | string |
id | ID |
name | string |
regionTitle | string |
regions | CountryRegion [] |
scaRequired | boolean |
CountryRegion
CountryRegion: Object
Type declaration
Name | Type |
---|---|
code | string |
id | ID |
name | string |
Coupon
Coupon: Object
A coupon object
Type declaration
Name | Type |
---|---|
amountOff | number | null |
couponId | string |
duration | "once" | "forever" | "multiple" |
durationInMonths | number | null |
id | ID |
name | string |
percentOff | number | 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
Name | Type |
---|---|
addressOne | string |
addressTwo | string | null |
city | string |
country | string |
countryCode | string |
countryId | Country ["id" ] |
firstName | string |
id | ID |
lastName | string |
phone | string |
region | string |
regionId | CountryRegion ["id" ] | null |
zip | string |
CustomerPickupInfo
CustomerPickupInfo: Object
Type declaration
Name | Type |
---|---|
firstName | string |
id | ID |
lastName | string |
phone | string |
pickupPoint | ExternalPickupPoint | null |
CustomerUpdatePayload
CustomerUpdatePayload: Object
Type declaration
Name | Type |
---|---|
externalId? | string | null |
firstName? | string |
lastName? | string |
marketingConsent? | boolean |
tosConsent? | boolean |
ExternalPickupPoint
ExternalPickupPoint: Object
Type declaration
Name | Type |
---|---|
addressOne | string |
addressTwo | string |
city | string |
countryCode | Country ["code" ] |
countryId | Country ["id" ] |
createdAt | string |
externalId | string |
id | ID |
type | mondialRelay |
updatedAt | string |
zip | string |
FunnelAcceptPayload
FunnelAcceptPayload: Object
Type declaration
Name | Type |
---|---|
offers | FunnelOfferPayload [] |
FunnelFetchResponse
FunnelFetchResponse: Object
Type declaration
Name | Type |
---|---|
step | FunnelStep | null |
FunnelOffer
FunnelOffer: Object
Type declaration
Name | Type |
---|---|
amountOff | number | null |
percentOff | number | null |
products | Product [] |
type | FunnelOfferType |
FunnelOfferPayload
FunnelOfferPayload: Object
Type declaration
Name | Type |
---|---|
options? | SubscriptionSurveyOption [] |
productId | Product ["id" ] |
FunnelOfferType
FunnelOfferType: "single"
| "multiple"
| "one_click"
FunnelPostAcceptPayload
FunnelPostAcceptPayload: Object
Type declaration
Name | Type |
---|---|
offers | FunnelOfferPayload [] |
paymentIntentId? | string | null |
shippingAddressId? | SubblyCart ["shippingAddressId" ] |
shippingMethodId? | SubblyCart ["shippingMethodId" ] |
FunnelPostAcceptResponse
FunnelPostAcceptResponse: CheckoutPurchaseResponse
FunnelStep
FunnelStep: Object
Type declaration
Name | Type |
---|---|
addon | boolean |
addonDuration | number | null |
description | string | null |
externalUrl? | string | null |
id | ID |
initial | boolean |
offer | FunnelOffer |
skipAnsweredSurvey? | boolean |
title | string |
type | FunnelType |
FunnelType
FunnelType: "funnel_pre_purchase" | "funnel_mid_purchase" | "funnel_post_purchase" | "funnel_post_purchase_complete"
FunnelsExpandableProperties
FunnelsExpandableProperties: "parent" | string
FunnelsResourceParams
FunnelsResourceParams: Object
Type declaration
Name | Type |
---|---|
expand | FunnelsExpandableProperties [] |
GatewayConnectableAuthNet
GatewayConnectableAuthNet: Object
Type declaration
Name | Type |
---|---|
apiLoginId | string |
publicKey | string |
GatewayConnectableBraintree
GatewayConnectableBraintree: Object
Type declaration
Name | Type |
---|---|
authorizeKey | string |
paypal | boolean |
GatewayConnectablePayPal
GatewayConnectablePayPal: Object
Type declaration
Name | Type |
---|---|
clientId | string |
GatewayConnectableStripe
GatewayConnectableStripe: Object
Type declaration
Name | Type |
---|---|
isoCountryCode | string | null |
publishableKey | string |
GiftCard
GiftCard: Object
A gift card object
Type declaration
Name | Type |
---|---|
amount | number |
balance | number |
code | string |
id | ID |
message | string |
status | GiftCardStatus |
GiftCardRecipient
GiftCardRecipient: Object
Type declaration
Name | Type |
---|---|
customerEmail | string | null |
customerName | string | null |
message | string | null |
GiftCardStatus
GiftCardStatus: "issued"
| "redeemed"
| "partially_used"
| "used"
| "cancelled"
| "expired"
ID
ID: number
InvoiceItem
InvoiceItem: Object
Type declaration
Name | Type |
---|---|
addonId | ID | null |
amount | number |
createdAt | string |
description | string |
digital | false |
discountAmount | 0 |
giftCard | GiftCardRecipient | null |
id | ID |
productId | Product ["id" ] |
quantity | number |
subscriptionId | ID | null |
survey | null |
taxAmount | 578 |
taxInclusive | true |
taxRate | number |
type | CartSummaryItemType |
updatedAt | string |
LeadSubscribePayload
LeadSubscribePayload: Object
Type declaration
Name | Type |
---|---|
email | string |
firstName? | string | null |
lastName? | string | null |
LeadSubscribeResponse
LeadSubscribeResponse: Object
Type declaration
Name | Type |
---|---|
email | string |
firstName | string | null |
id | ID |
ipAddress | string |
lastName | string | null |
userAgent | string |
LocalDelivery
LocalDelivery: Object
Type declaration
Name | Type |
---|---|
comment | string | null |
duration | string |
name | string |
Pagination
Pagination: Object
Type declaration
Name | Type |
---|---|
currentPage | number |
from | number |
lastPage | number |
to | number |
total | number |
ParentProduct
ParentProduct: ProductSubscription
| ProductOneTime
PaymentIntentResponse
PaymentIntentResponse: Object
Type declaration
Name | Type |
---|---|
amount | number |
createdAt | string |
currencyCode | string |
id | string |
invoiceId | ID |
paymentMethodId | PaymentMethod ["id" ] |
status | "requires_confirmation" | string |
token | string |
updatedAt | string |
PaymentMethod
PaymentMethod: Object
Type declaration
Name | Type |
---|---|
acssDebit | PaymentMethodAcssDebit | null |
bancontact | PaymentMethodBancontact | null |
card | PaymentMethodCard | null |
cashapp | PaymentMethodCashapp | null |
id | ID |
ideal | PaymentMethodIdeal | null |
identifier | string |
link | PaymentMethodLink | null |
sepaDebit | PaymentMethodSepaDebit | null |
sofort | PaymentMethodSofort | null |
type | PaymentMethodType |
usBankAccount? | PaymentMethodUsBankAccount | null |
PaymentMethodAcssDebit
PaymentMethodAcssDebit: Object
Type declaration
Name | Type |
---|---|
bankName | string |
email | string |
institutionNumber | string |
lastFour | string |
name | string |
transitNumber | string |
PaymentMethodBancontact
PaymentMethodBancontact: Object
Type declaration
Name | Type |
---|---|
email | string |
name | string |
PaymentMethodCard
PaymentMethodCard: Object
Type declaration
Name | Type |
---|---|
brand | "visa" | "mastercard" | string |
expiryMonth | string |
expiryYear | string |
last4 | string |
type | string |
PaymentMethodCashapp
PaymentMethodCashapp: Object
Type declaration
Name | Type |
---|---|
buyerId | string |
cashTag | string |
email | string |
name | string |
PaymentMethodIdeal
PaymentMethodIdeal: Object
Type declaration
Name | Type |
---|---|
bank | "revolut" | string |
bic | string |
email | string |
name | string |
PaymentMethodLink
PaymentMethodLink: Object
Type declaration
Name | Type |
---|---|
email | string |
name | string |
PaymentMethodSepaDebit
PaymentMethodSepaDebit: Object
Type declaration
Name | Type |
---|---|
bank_code | string |
branch_code | string |
country | string |
email | string |
ibanLast4 | string |
name | string |
PaymentMethodSofort
PaymentMethodSofort: Object
Type declaration
Name | Type |
---|---|
country | string |
email | string |
name | string |
PaymentMethodStorePayload
PaymentMethodStorePayload: Object
Type declaration
Name | Type |
---|---|
gatewayId | ShopGateway ["id" ] |
token | string |
PaymentMethodType
PaymentMethodType: "card"
| "paypal"
| "us_bank_account"
| "bancontact"
| "sofort"
| "ideal"
| "cashapp"
| "link"
| "sepa_debit"
| "acss_debit"
PaymentMethodUsBankAccount
PaymentMethodUsBankAccount: Object
Type declaration
Name | Type |
---|---|
accountHolderType | "company" | "individual" | string |
accountType | "checking" | "savings" | string |
bankName | string |
email | string |
last4 | string |
name | string |
routingNumber | string |
PickupInfoFetchParams
PickupInfoFetchParams: Object
Type declaration
Name | Type |
---|---|
shippingMethodId? | ShippingMethodPickup ["id" ] |
PickupInfoStorePayload
PickupInfoStorePayload: Object
Type declaration
Name | Type |
---|---|
firstName | CustomerPickupInfo ["firstName" ] |
lastName | CustomerPickupInfo ["lastName" ] |
phone | CustomerPickupInfo ["phone" ] |
pickupPointId? | string |
pickupPointType? | mondialRelay |
PickupPoint
PickupPoint: Object
Type declaration
Name | Type |
---|---|
addressOne | string |
addressTwo | string | null |
city | string |
comment | string |
country | string |
countryCode? | string |
id | ID |
name | string |
phone | string |
price | number |
region | string |
type | PickupPointType |
workingHours | string |
zip | string |
PriceSchemeRange
PriceSchemeRange: Object
Type declaration
Name | Type |
---|---|
amount | number |
id | ID |
range | number |
Product
Product: ProductPricing
| ProductVariant
ProductBase
ProductBase: Object
Type declaration
Name | Type |
---|---|
bundle | Bundle | null |
bundleId | Bundle ["id" ] | null |
bundleRulesetId | BundleRuleset ["id" ] | null |
collectShippingAddress | boolean |
createdAt | string |
deliveryInfo | string | null |
description | string | null |
digital | boolean |
giftingEnabled | boolean |
id | ID |
images | ProductImage [] |
name | string |
slug | string |
ProductImage
ProductImage: Object
Type declaration
Name | Type |
---|---|
createdAt | string |
id | ID |
order | number |
updatedAt | string |
url | string |
ProductOneTime
ProductOneTime: ProductBase
& { giftCard
: boolean
; giftCardExpiration
: number | null
; type
: oneTime
; variants
: ProductVariant
[] }
ProductPriceScheme
ProductPriceScheme: Object
Type declaration
Name | Type |
---|---|
id | ID |
ranges | PriceSchemeRange [] |
type | "volume_price" | string |
ProductPricing
ProductPricing: Object
Type declaration
Name | Type |
---|---|
bundlePlanId | BundlePlan ["id" ] | null |
chargeImmediately | boolean |
chargesLimit | number | null |
commitmentBillingCount | number |
createdAt | string |
cutOffAt | string | null |
description | string | null |
frequencyCount | number |
frequencyUnit | FrequencyUnit |
id | number |
name | string |
parent | ProductSubscription |
price | number |
priceScheme | ProductPriceScheme | null |
pricingName | string | null |
rebillingStartAt | string | null |
shipImmediately | boolean |
shippings | ProductShipping [] |
stockCount | number | null |
survey | Survey | null |
trialLength | number | null |
trialPrice | number | null |
ProductRequestHeaders
ProductRequestHeaders: RequestHeaders
& { x-currency?
: string
}
ProductShipping
ProductShipping: Object
Type declaration
Name | Type |
---|---|
addCount | number | null |
addUnit | FrequencyUnit |
createdAt | string |
id | ID |
shippingAt | string | null |
updatedAt | string |
ProductSubscription
ProductSubscription: ProductBase
& { preOrderEndAt
: string \| null
; pricings
: ProductPricing
[] ; setupFee
: number
; type
: subscription
}
ProductUnknown
ProductUnknown: Product
| ParentProduct
ProductVariant
ProductVariant: Object
Type declaration
Name | Type |
---|---|
bundlePlanId | BundlePlan ["id" ] | null |
createdAt | string |
description | string | null |
id | ID |
name | string |
options | ProductVariantOption [] |
parent | ProductOneTime |
price | number |
priceScheme | ProductPriceScheme | null |
stockCount | number | null |
ProductVariantOption
ProductVariantOption: Object
Type declaration
Name | Type |
---|---|
id | ID |
name | string |
value | string |
ProductsExpandableProperties
ProductsExpandableProperties: "variants"
| "pricings"
| "pricings.parent"
| "variants.parent"
| string
ProductsListParams
ProductsListParams: Object
Type declaration
Name | Type |
---|---|
expand? | ProductsExpandableProperties [] |
page? | number |
perPage? | number |
ProductsListResponse
ProductsListResponse: Object
Type declaration
Name | Type |
---|---|
data | ParentProduct [] |
pagination | Pagination |
ProductsResourceParams
ProductsResourceParams: Object
Type declaration
Name | Type |
---|---|
expand? | ProductsExpandableProperties [] |
PurchaseExpandProperty
PurchaseExpandProperty: "subscription.product"
| "subscription.product.parent"
| "subscription.product.parent.bundle"
| string
PurchaseInvoice
PurchaseInvoice: Object
Type declaration
Name | Type |
---|---|
adjustment | number |
billingAddressId | CustomerAddress ["id" ] | null |
createdAt | string |
currencyCode | string |
customerId | SubblyCustomer ["id" ] |
description | string |
discounts | unknown [] |
discountsAmount | number |
firstShipmentAt | string | null |
id | ID |
items | InvoiceItem [] |
paid_at | string | null |
periodEnd | string | null |
periodStart | string | null |
shippingAddressId | CustomerAddress ["id" ] | null |
shippingMethodId | ShippingMethod ["id" ] | null |
status | "paid" | string |
subTotal | number |
taxAmount | number |
total | number |
updatedAt | string |
PurchaseOrder
PurchaseOrder: Object
Type declaration
Name | Type |
---|---|
adjustment | number |
created_at | string |
currencyCode | string |
customerId | SubblyCustomer ["id" ] |
discounts | [] |
dueDate | string | null |
gift | null |
id | ID |
invoiceId | PurchaseInvoice ["id" ] |
items | unknown [] |
shippingAddressId | CustomerAddress ["id" ] | null |
shippingItems | unknown [] |
shippingMethodId | ShippingMethod ["id" ] | null |
status | "Awaiting Delivery" | string |
subTotal | 4468 |
subscriptionId | PurchaseSubscription ["id" ] | null |
taxAmount | number |
total | number |
updatedAt | string |
PurchaseRequestParams
PurchaseRequestParams: Object
Type declaration
Name | Type |
---|---|
expand? | PurchaseExpandProperty [] |
PurchaseSubscription
PurchaseSubscription: Object
Type declaration
Name | Type |
---|---|
addons | unknown [] |
billingAddressId | CustomerAddress ["id" ] | null |
cancelAtEndOfCommitment | boolean |
cancellations | unknown [] |
commitmentTermTotalPayments | number |
createdAt | string |
currencyCode | string |
customerId | SubblyCustomer ["id" ] |
discounts | unknown [] |
gift | unknown |
id | ID |
lastPaymentAt | string | null |
nextPaymentDate | string |
paymentMethodId | PaymentMethod ["id" ] |
productId | Product ["id" ] |
referredBy | ID | null |
shippingAddressId | CustomerAddress ["id" ] | CustomerPickupInfo ["id" ] | null |
shippingMethodId | ShippingMethod ["id" ] | null |
status | "active" | string |
survey | SubscriptionSurvey | null |
updatedAt | string |
ShippingMethod
ShippingMethod: ShippingMethodDelivery
| ShippingMethodPickup
ShippingMethodDelivery
ShippingMethodDelivery: ShippingMethodShippingOption
| ShippingMethodLocalDelivery
ShippingMethodLocalDelivery
ShippingMethodLocalDelivery: Object
Type declaration
Name | Type |
---|---|
futureShippingFee | number |
id | ID |
method | LocalDelivery |
shippingFee | number |
type | "local_delivery" |
ShippingMethodPickup
ShippingMethodPickup: Object
Pick-up point shipping method
Type declaration
Name | Type |
---|---|
futureShippingFee | number |
id | ID |
method | PickupPoint |
shippingFee | number |
type | "local_pickup" |
ShippingMethodShippingOption
ShippingMethodShippingOption: Object
Type declaration
Name | Type |
---|---|
futureShippingFee | number |
id | ID |
method | ShippingOption |
shippingFee | number |
type | "shipping_option" |
ShippingOption
ShippingOption: Object
Type declaration
Name | Type |
---|---|
duration | null |
name | string |
type | "flat_price" | "product" | "price" | "weight" |
ShopApp
ShopApp: Object
Type declaration
Name | Type |
---|---|
properties | Record <string , string | number | boolean > |
type | ShopAppType |
ShopAppType
type ShopAppType = 'ga' | 'google_tag' | 'facebook_pixel' | 'google_login' | 'facebook_login' | string
ShopBranding
ShopBranding: Object
Type declaration
Name | Type |
---|---|
brandColour | string | null |
favicon | string | null |
logoSquare | string | null |
ShopCartSettings
ShopCartSettings: Object
Type declaration
Name | Type |
---|---|
accentColor | string | null |
afterItemAdded | notify | summary | checkout | null |
backgroundColor | string | null |
buttonStyle | number | null |
cardBackgroundColor | string | null |
cardBorderColor | string | null |
cardDividerColor | string | null |
cardStyle | number | null |
checkoutLayoutOneStep | boolean |
fontColorPrimary | string | null |
fontColorSecondary | string | null |
fontStyle | string | null |
footerBackground | string | null |
footerFontColor | string | null |
headerBackgroundColor | string | null |
headerFontColor | string | null |
headerHeight | number | null |
hidePricingPrice | boolean |
inputBackground | string | null |
inputBorderColor | string | null |
inputFontColor | string | null |
itemAddedScreen | boolean |
localizationSettings | boolean |
segmentControlBackground | string | null |
widgetBackgroundColor | string | null |
widgetBackgroundDarker | string | null |
widgetView | "pop-up" | "fullscreen" |
ShopCountry
ShopCountry: Object
Type declaration
Name | Type |
---|---|
code | string |
currencyCode | string |
id | ID |
name | string |
ShopCurrency
ShopCurrency: Object
Type declaration
Name | Type |
---|---|
abbreviation | string |
gateways | ShopGateway [] |
html | string |
name | string |
symbol | string |
ShopGateway
ShopGateway: ShopGatewayStripe
| ShopGatewayBraintree
| ShopGatewayPayPal
| ShopGatewayAuthNet
ShopGatewayAuthNet
ShopGatewayAuthNet: Object
Type declaration
Name | Type |
---|---|
connectable | GatewayConnectableAuthNet |
id | ID |
name | authorizeNet |
type | card |
ShopGatewayBraintree
ShopGatewayBraintree: Object
Type declaration
Name | Type |
---|---|
connectable | GatewayConnectableBraintree |
id | ID |
name | braintree |
type | card | paypal |
ShopGatewayPayPal
ShopGatewayPayPal: Object
Type declaration
Name | Type |
---|---|
connectable | GatewayConnectablePayPal |
id | ID |
name | paypal |
type | paypal |
ShopGatewayStripe
ShopGatewayStripe: Object
Type declaration
Name | Type |
---|---|
connectable | GatewayConnectableStripe |
id | ID |
name | stripe |
type | card |
ShopLanguage
ShopLanguage: Object
Type declaration
Name | Type |
---|---|
code | string |
currencyPosition | number | 1 | 0 |
dictionary | Record <string , string > |
name | string |
primary | boolean |
published | boolean |
ShopLimits
ShopLimits: Object
Type declaration
Name | Type |
---|---|
checkoutWidget | boolean |
configurableBundles | boolean |
embedCheckout | boolean |
outOfStock | boolean |
whiteLabeling | boolean |
ShopReferralSettings
ShopReferralSettings: Object
Type declaration
Name | Type |
---|---|
enabled | boolean |
refereeDiscount | number |
referralDiscount | number |
ShopSettings
ShopSettings: Object
Type declaration
Name | Type |
---|---|
allowCouponDiscount | boolean |
allowGiftCardDiscount | boolean |
applePay | boolean |
collectBillingAddress | boolean |
collectBuyerName | boolean |
collectGiftRecipientEmail | boolean |
displayCommitmentAndTrial | boolean |
facebookConversionEnabled | boolean |
giftDurationEnabled | boolean |
giftStartDateEnabled | boolean |
googlePay | boolean |
limitCouponAndReferralDiscount | boolean |
localPickupOnly | boolean |
marketingConsentRequired | boolean |
outOfStockEnabled | boolean |
phoneNumberOptional | boolean |
registerWithoutPassword | boolean |
scaEnabled | boolean |
skipPaymentMethodWithGiftCard | boolean |
subscriptionAddons | boolean |
subscriptionQuantitySelector | boolean |
taxEnabled | boolean |
taxInclusive | boolean |
timezone | string | null |
tosConsentRequired | boolean |
zeroChargeNotification | boolean |
StockSubscriptionPayload
StockSubscriptionPayload: Object
Type declaration
Name | Type |
---|---|
answerId? | ID |
email | string |
productId? | ID |
quantity? | number |
StockSubscriptionResponse
StockSubscriptionResponse: Object
Type declaration
Name | Type |
---|---|
createdAt | string |
email | string |
entityId | ID |
entityType | "product" | "survey_answer" |
id | ID |
inStockAt | string |
productId | ID |
quantity | number |
shopId | ID |
updatedAt | string |
SubblyCart
SubblyCart: Object
Subbly cart contains all the customer's order progress information
Type declaration
Name | Type |
---|---|
adjustment | number |
attached | boolean |
balanceChange | CartBalanceChange |
baseCurrencyCode | string |
billingAddress | CustomerAddress | null |
billingAddressId | CustomerAddress ["id" ] | null |
coupon? | Coupon | null |
couponCode | string | null |
createdAt | string |
currencyCode | string |
customerId | SubblyCustomer ["id" ] | null |
discountTotal | number |
discounts | CartDiscount [] |
futureShippingFee | number |
giftCard? | GiftCard | null |
giftCardCode | string | null |
giftInfo | CartGiftInfo |
id | string |
items | CartItem [] |
paymentMethod | PaymentMethod | null |
paymentMethodId | PaymentMethod ["id" ] | null |
referralId | ID | null |
shippingAddress | CustomerAddress | CustomerPickupInfo | null |
shippingAddressId | CustomerAddress ["id" ] | CustomerPickupInfo ["id" ] | null |
shippingMethod | ShippingMethod | null |
shippingMethodId | ShippingMethod ["id" ] | null |
shopId | ID |
status | CartStatus |
subTotal | number |
summaryItems | CartSummaryItem [] |
taxInclusive | boolean |
taxRate | number |
taxTotal | number |
total | number |
updatedAt | string |
SubblyCustomer
SubblyCustomer: Object
Type declaration
Name | Type |
---|---|
createdAt | string |
email | string |
firstName | string |
id | ID |
lastName | string |
marketingConsent | boolean |
tosConsentAt | string |
userId | ID |
SubblyError
SubblyError: SubblyErrorGeneric
| SubblyErrorPurchase
SubblyErrorGeneric
SubblyErrorGeneric: Object
Type declaration
Name | Type |
---|---|
code | SubblyErrorCodes | string |
message | string |
SubblyErrorPurchase
SubblyErrorPurchase: Object
Type declaration
Name | Type |
---|---|
code | paymentRequiresAction |
message | string |
paymentIntentId? | string |
SubblyShop
SubblyShop: Object
Type declaration
Name | Type |
---|---|
apps | ShopApp [] |
branding | ShopBranding |
cartSettings | ShopCartSettings |
checkoutJs | string | null |
checkoutUrl | string |
conversionTrackingCode | string | null |
country | ShopCountry |
currencies | ShopCurrency [] |
languages | ShopLanguage [] |
limits | ShopLimits |
localPickupOnly | boolean |
name | string |
referralSettings | ShopReferralSettings | null |
settings | ShopSettings |
shippingCountries | Country [] |
shopId | ID |
slug | string |
status | boolean |
supportEmail | string |
supportUrl | string |
termsAndConditions | string |
url | string |
Subscription
Subscription: Object
Type declaration
Name | Type |
---|---|
addons | SubscriptionAddon [] |
billingAddressId | CustomerAddress ["id" ] | null |
bundle | SubscriptionBundle | null |
cancelAtEndOfCommitment | boolean |
cancellations | SubscriptionCancellation [] |
chargesLimit | number | null |
commitmentTermTotalPayments | number | null |
createdAt | string |
currency_code | string |
customerId | SubblyCustomer ["id" ] |
discounts | SubscriptionDiscount |
expiredAt | string | null |
gift | SubscriptionGift | null |
id | ID |
lastPaymentAt | string | null |
nextPaymentDate | string |
paymentMethodId | PaymentMethod ["id" ] |
product | ProductPricing |
productId | ID |
quantity | number |
referredBy | ID | null |
shippingAddressId | CustomerAddress ["id" ] | CustomerPickupInfo ["id" ] | null |
shippingMethodId | ShippingMethod ["id" ] | null |
status | SubscriptionStatus |
survey | SubscriptionSurvey | null |
updatedAt | string |
SubscriptionAddon
SubscriptionAddon: Object
Type declaration
Name | Type |
---|---|
createdAt | string |
discounts | SubscriptionDiscount [] |
duration | number |
id | ID |
product | ProductVariant | null |
productId | ProductVariant ["id" ] |
quantity | number |
subscriptionId | Subscription ["id" ] |
updatedAt | string |
SubscriptionBundle
SubscriptionBundle: Object
Type declaration
Name | Type |
---|---|
items | BundleItem [] |
preferences | CartItemBundlePreference [] |
SubscriptionBundlePayload
SubscriptionBundlePayload: Object
Type declaration
Name | Type |
---|---|
bundle | { items : BundlePayloadItem [] | null ; preferences : BundlePayloadPreference [] | null } |
bundle.items | BundlePayloadItem [] | null |
bundle.preferences | BundlePayloadPreference [] | null |
productId | Product ["id" ] | null |
quantity | number | null |
SubscriptionCancellation
SubscriptionCancellation: Object
Type declaration
Name | Type |
---|---|
createdAt | string |
end | string | null |
extraFeedback | string | null |
id | ID |
reason | string | null |
reasonSubmittedOn | string | null |
start | string |
subscriptionId | Subscription ["id" ] |
updatedAt | string |
SubscriptionDiscount
SubscriptionDiscount: Object
Type declaration
Name | Type |
---|---|
amountOff | number | null |
couponId | Coupon ["id" ] | null |
createdAt | string |
customerId | SubblyCustomer ["id" ] |
end | string | null |
id | ID |
percentOff | number | null |
start | string | null |
updatedAt | string |
SubscriptionGift
SubscriptionGift: Object
Type declaration
Name | Type |
---|---|
message | string | null |
orderLimit | number | null |
startsAt | string | null |
SubscriptionPreferencesPayload
SubscriptionPreferencesPayload: Object
Type declaration
Name | Type |
---|---|
preferences | SubscriptionSurveyOption [] | null |
updateOrders | boolean |
SubscriptionStatus
SubscriptionStatus: "active"
| "trial"
| "pre_order"
| "gift_waiting_to_start"
| "cancelled"
| "switched"
| "expired"
SubscriptionSurvey
SubscriptionSurvey: Object
Answered subscription survey
Type declaration
Name | Type |
---|---|
data | SubscriptionSurveyOption [] |
surveyId | Survey ["id" ] |
SubscriptionSurveyOption
SubscriptionSurveyOption: Object
Subscription survey option containing answers
Type declaration
Name | Type |
---|---|
answers | SubscriptionSurveyOptionAnswer [] |
questionId | ID |
SubscriptionSurveyOptionAnswer
SubscriptionSurveyOptionAnswer: SurveyOptionAnswerText
| SurveyOptionAnswerSelect
| SurveyOptionAnswerMultiple
| SurveyOptionAnswerQuantity
| SurveyOptionAnswerPlan
| SurveyOptionAnswerOffer
| SurveyOptionAnswerEmail
Subscription survey option answer
SubscriptionUpdatePayload
SubscriptionUpdatePayload: Object
Type declaration
Name | Type |
---|---|
quantity | number |
SubscriptionsExpandProps
SubscriptionsExpandProps: "product"
| "product.parent"
| "bundle.items.product"
| "bundle.items.product.parent"
| string
SubscriptionsResourceParams
SubscriptionsResourceParams: Object
Type declaration
Name | Type |
---|---|
expand | SubscriptionsExpandProps [] |
SummaryBundleItem
SummaryBundleItem: Object
Type declaration
Name | Type |
---|---|
discount | number | null |
id | CartItem ["id" ] |
price | number |
productId | ProductOneTime ["id" ] |
quantity | number |
subTotal | number |
taxAmount | number |
taxInclusive | boolean |
taxRate | number |
total | number |
SummarySubscriptionItemInfo
SummarySubscriptionItemInfo: Object
Type declaration
Name | Type |
---|---|
firstPaymentAt | string | null |
firstShipmentAt | string | null |
nextPaymentAt | string | null |
numberOfShipments | number | null |
Survey
Survey: Object
Type declaration
Name | Type |
---|---|
appearanceType | SurveyAppearanceType |
customizations | SurveyCustomizations |
id | number |
multiplyPriceByShipmentNumber | boolean |
questions | SurveyQuestion[] |
title | string |
SurveyAnswer
SurveyAnswer: SurveyAnswerSelect
| SurveyAnswerMultiple
| SurveyAnswerQuantity
| SurveyAnswerPlan
| SurveyAnswerOffer
SurveyAnswerMultiple
SurveyAnswerMultiple: Object
Type declaration
Name | Type |
---|---|
content | string | null |
createdAt | string |
customizations | null |
default | boolean |
description | string | null |
id | ID |
imageUrl | string | null |
position | number |
price | number |
stockCount | string | null |
updatedAt | string |
SurveyAnswerOffer
SurveyAnswerOffer: Object
Type declaration
Name | Type |
---|---|
content | string | null |
createdAt | string |
customizations | AnswerOfferCustomizations |
description | string | null |
id | ID |
imageUrl | string | null |
position | number |
price | number |
product | Product | null |
productId | ProductVariant ["id" ] | null |
updatedAt | string |
SurveyAnswerPlan
SurveyAnswerPlan: Object
Type declaration
Name | Type |
---|---|
content | string | null |
createdAt | string |
customizations | AnswerPlanCustomizations |
default | boolean |
description | string | null |
id | ID |
imageUrl | string | null |
position | number |
price | number |
product | Product | null |
productId | ProductVariant ["id" ] | null |
updatedAt | string |
SurveyAnswerQuantity
SurveyAnswerQuantity: Object
Type declaration
Name | Type |
---|---|
content | string | null |
createdAt | string |
customizations | null |
defaultQuantity | number |
description | string | null |
id | ID |
imageUrl | string | null |
position | number |
price | number |
stockCount | number | null |
updatedAt | string |
SurveyAnswerSelect
SurveyAnswerSelect: Object
Type declaration
Name | Type |
---|---|
content | string | null |
createdAt | string |
customizations | null |
default | boolean |
description | string | null |
id | ID |
imageUrl | string | null |
position | number |
price | number |
stockCount | number | null |
updatedAt | string |
SurveyCustomizations
SurveyCustomizations: Object
Type declaration
Name | Type |
---|---|
progressType | SurveyProgressType |
SurveyExpandableProperties
SurveyExpandableProperties: "questions.answers.product.parent"
| string
SurveyOptionAnswerEmail
SurveyOptionAnswerEmail: Object
Type declaration
Name | Type |
---|---|
content | string |
SurveyOptionAnswerMultiple
SurveyOptionAnswerMultiple: Object
Survey multiple option type answer
Type declaration
Name | Type |
---|---|
id | ID |
SurveyOptionAnswerOffer
SurveyOptionAnswerOffer: Object
Survey offer type answer object
Type declaration
Name | Type |
---|---|
id | ID |
SurveyOptionAnswerPlan
SurveyOptionAnswerPlan: Object
Survey plan type answer object
Type declaration
Name | Type |
---|---|
id | ID |
SurveyOptionAnswerQuantity
SurveyOptionAnswerQuantity: Object
Survey quantity option type answer
Type declaration
Name | Type |
---|---|
id | ID |
quantity | number |
SurveyOptionAnswerSelect
SurveyOptionAnswerSelect: Object
Survey select type answer object
Type declaration
Name | Type |
---|---|
id | ID |
SurveyOptionAnswerText
SurveyOptionAnswerText: Object
Type declaration
Name | Type |
---|---|
content | string |
SurveyProgressType
SurveyProgressType: "steps" | "dots" | "bar"
SurveyQuestion
SurveyQuestion: SurveyQuestionOffer
| SurveyQuestionQuantity
| SurveyQuestionMultiple
| SurveyQuestionSelect
| SurveyQuestionText
| SurveyQuestionEmail
| SurveyQuestionPlan
SurveyQuestionMultiple
SurveyQuestionMultiple: Object
Type declaration
Name | Type |
---|---|
answers | SurveyAnswerMultiple [] |
createdAt | string |
customizations | QuestionMultipleCustomizations |
description | string | null |
id | ID |
maxAmount | number | null |
maxCount | number | null |
minAmount | number | null |
minCount | number | null |
position | number |
required | boolean |
title | string |
type | multiple |
updatedAt | string |
SurveyQuestionOffer
SurveyQuestionOffer: Object
Type declaration
Name | Type |
---|---|
answers | SurveyAnswerOffer [] |
createdAt | string |
customizations | null |
description | string | null |
id | ID |
position | number |
required | boolean |
title | string |
type | offer |
updatedAt | string |
SurveyQuestionPlan
SurveyQuestionPlan: Object
Type declaration
Name | Type |
---|---|
answers | SurveyAnswerPlan [] |
createdAt | string |
customizations | QuestionPlanCustomizations |
description | string | null |
id | ID |
position | number |
required | boolean |
title | string |
type | plan |
updatedAt | string |
SurveyQuestionQuantity
SurveyQuestionQuantity: Object
Type declaration
Name | Type |
---|---|
answers | SurveyAnswerQuantity [] |
createdAt | string |
customizations | null |
description | string | null |
id | ID |
maxAmount | number | null |
maxCount | number | null |
minAmount | number | null |
minCount | number | null |
position | number |
required | boolean |
title | string |
type | quantity |
updatedAt | string |
SurveyQuestionSelect
SurveyQuestionSelect: Object
Type declaration
Name | Type |
---|---|
answers | SurveyAnswerSelect [] |
createdAt | string |
customizations | QuestionSelectCustomizations |
description | string | null |
id | ID |
position | number |
required | boolean |
title | string |
type | select |
updatedAt | string |
SurveyQuestionText
SurveyQuestionText: Object
Type declaration
Name | Type |
---|---|
answers | never [] |
createdAt | string |
customizations | QuestionTextCustomizations |
description | string | null |
id | ID |
position | number |
required | boolean |
title | string |
type | text |
updatedAt | string |
SurveyRequestHeaders
SurveyRequestHeaders: RequestHeaders
& { x-currency?
: string
}
SurveyResourceParams
SurveyResourceParams: Object
Type declaration
Name | Type |
---|---|
expand? | SurveyExpandableProperties [] |
WalletSetupIntentPayload
WalletSetupIntentPayload: Object
Type declaration
Name | Type |
---|---|
gatewayId | ShopGateway["id"] |
redirectUrl | string |
WalletSetupIntentResponse
WalletSetupIntentResponse: Object
Type declaration
Name | Type |
---|---|
expiresAt | string |
id | string |
redirectUrl | string |
subblyUrl | string |
WalletSetupPayload
WalletSetupPayload: Object
Type declaration
Name | Type |
---|---|
gatewayId | ShopGateway ["id" ] |
WalletSetupResponse
WalletSetupResponse: Object
Type declaration
Name | Type |
---|---|
token | string |
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'
}