bloombox / bloombox.client.services.shop / ShopClient / ShopContext

ShopContext

data class ShopContext (source)

Specifies contextual information for a shop operation. Required info, aside from the standard API key required for all transactions with the Bloombox API, includes the desired partner and location code. They can be specified here to override context for a specific client instance or request. If left unspecified, defaults are used.

Constructors

<init>

ShopContext(partner: String? = null, location: String? = null)

Specifies contextual information for a shop operation. Required info, aside from the standard API key required for all transactions with the Bloombox API, includes the desired partner and location code. They can be specified here to override context for a specific client instance or request. If left unspecified, defaults are used.

Companion Object Functions

defaultContext

fun defaultContext(): ShopContext

Generate a default shop context. In this case, resolution of the partner and location code is left to the outer library context. This is most useful in cases where the partner and location code won't change during the lifetime of an API client.