@agorio/sdk • Docs

Class: BigCommerceAdapter

Adapter interface for connecting to real e-commerce platforms. Implement this to add support for Shopify, WooCommerce, or any platform.

Implements

• MerchantAdapter

Constructors

new BigCommerceAdapter()

new BigCommerceAdapter(options): BigCommerceAdapter

Parameters

• options: BigCommerceAdapterOptions

Returns

BigCommerceAdapter

Defined in

src/adapters/bigcommerce.ts:102

Properties

adapterType

readonly adapterType: "bigcommerce" = 'bigcommerce'

Human-readable adapter name (e.g., ‘shopify’, ‘woocommerce’)

Implementation of

MerchantAdapter.adapterType

Defined in

src/adapters/bigcommerce.ts:93

Accessors

domain

Get Signature

get domain(): string

Returns

string

Defined in

src/adapters/bigcommerce.ts:117

Methods

completeCheckout()

completeCheckout(sessionId, payment, shippingAddress): Promise<object>

Complete a checkout (optional)

Parameters

• sessionId: string

• payment

• payment.method: string

• payment.token?: string

• shippingAddress: ShippingAddress

Returns

Promise<object>

orderId

orderId: string

status

status: string

Implementation of

MerchantAdapter.completeCheckout

Defined in

src/adapters/bigcommerce.ts:246

createCheckout()

createCheckout(items): Promise<object>

Create a checkout session (optional — not all adapters support purchase)

Parameters

• items: CartItem[]

Returns

Promise<object>

sessionId

sessionId: string

shippingOptions?

optional shippingOptions: object[]

totals

totals: object

totals.subtotal

subtotal: MoneyAmount

totals.total

total: MoneyAmount

Implementation of

MerchantAdapter.createCheckout

Defined in

src/adapters/bigcommerce.ts:211

discover()

discover(_domain): Promise<MerchantAdapterDiscovery>

Discover/connect to a merchant by domain

Parameters

• _domain: string

Returns

Promise<MerchantAdapterDiscovery>

Implementation of

MerchantAdapter.discover

Defined in

src/adapters/bigcommerce.ts:128

getProduct()

getProduct(productId): Promise<MockProduct>

Get a single product by ID

Parameters

• productId: string

Returns

Promise<MockProduct>

Implementation of

MerchantAdapter.getProduct

Defined in

src/adapters/bigcommerce.ts:204

listProducts()

listProducts(options?): Promise<object>

List products from the catalog

Parameters

• options?

• options.category?: string

• options.limit?: number

• options.page?: number

Returns

Promise<object>

products

products: MockProduct[]

total

total: number

Implementation of

MerchantAdapter.listProducts

Defined in

src/adapters/bigcommerce.ts:158

matchesDomain()

matchesDomain(domain): boolean

Parameters

• domain: string

Returns

boolean

Defined in

src/adapters/bigcommerce.ts:121

searchProducts()

searchProducts(query, limit?): Promise<object>

Search products by keyword

Parameters

• query: string

• limit?: number

Returns

Promise<object>

products

products: MockProduct[]

query

query: string

total

total: number

Implementation of

MerchantAdapter.searchProducts

Defined in

src/adapters/bigcommerce.ts:183