io.sphere.sdk.stores

Interface Store

All Superinterfaces:

CreationTimestamped, Custom, Identifiable<Store>, Referenceable<Store>, Resource<Store>, ResourceIdentifiable<Store>, ResourceView<Store,Store>, Timestamped, Versioned<Store>, WithKey

public interface Store
extends Resource<Store>, Custom, WithKey

Stores let you model the context your customers shop in, e.g. physical retail locations, brand stores, or country-specific stores. Additionally, a store can be used for permissions. With an OAuth scope like `manage_orders:acme-inc:luxury-brand`, an API client can only work with carts and orders inside the `luxury-brand` store, but not within the `budget-brand` store.

Method Summary

Modifier and Type	Method and Description
List<Reference<Channel>>	getDistributionChannels() Optional connection to particular supplier.
String	getKey()
List<String>	getLanguages()
LocalizedString	getName()
List<ProductSelectionSetting>	getProductSelections()
List<Reference<Channel>>	getSupplyChannels() Optional connection to particular supplier.
static Reference<Store>	referenceOfId(String id)
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
default Reference<Store>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<Store>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Methods inherited from interface io.sphere.sdk.types.Custom

getCustom

Method Detail

getKey

String getKey()

Specified by:

getKey in interface WithKey

getName

@Nullable
LocalizedString getName()

getLanguages

@Nullable
List<String> getLanguages()

getDistributionChannels

@Nullable
List<Reference<Channel>> getDistributionChannels()

Optional connection to particular supplier.

Returns:

channel or null

See Also:

SetDistributionChannels

getSupplyChannels

@Nullable
List<Reference<Channel>> getSupplyChannels()

Optional connection to particular supplier.

Returns:

channel or null

See Also:

SetSupplyChannels

getProductSelections

@Nullable
List<ProductSelectionSetting> getProductSelections()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<Store> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

toReference

default Reference<Store> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<Store>

Specified by:

toReference in interface Resource<Store>

Returns:

reference

referenceOfId

static Reference<Store> referenceOfId(String id)