Skip to main content

ShippingMethodService

ShippingMethodService​

@vendure/coreshipping-method.service.ts

Contains methods relating to ShippingMethod entities.

Signature
class ShippingMethodService {
    constructor(connection: TransactionalConnection, configService: ConfigService, roleService: RoleService, listQueryBuilder: ListQueryBuilder, channelService: ChannelService, configArgService: ConfigArgService, translatableSaver: TranslatableSaver, customFieldRelationService: CustomFieldRelationService, eventBus: EventBus, translator: TranslatorService)
    findAll(ctx: RequestContext, options?: ListQueryOptions<ShippingMethod>, relations: RelationPaths<ShippingMethod> = []) => Promise<PaginatedList<Translated<ShippingMethod>>>;
    findOne(ctx: RequestContext, shippingMethodId: ID, includeDeleted:  = false, relations: RelationPaths<ShippingMethod> = []) => Promise<Translated<ShippingMethod> | undefined>;
    create(ctx: RequestContext, input: CreateShippingMethodInput) => Promise<Translated<ShippingMethod>>;
    update(ctx: RequestContext, input: UpdateShippingMethodInput) => Promise<Translated<ShippingMethod>>;
    softDelete(ctx: RequestContext, id: ID) => Promise<DeletionResponse>;
    assignShippingMethodsToChannel(ctx: RequestContext, input: AssignShippingMethodsToChannelInput) => Promise<Array<Translated<ShippingMethod>>>;
    removeShippingMethodsFromChannel(ctx: RequestContext, input: RemoveShippingMethodsFromChannelInput) => Promise<Array<Translated<ShippingMethod>>>;
    getShippingEligibilityCheckers(ctx: RequestContext) => ConfigurableOperationDefinition[];
    getShippingCalculators(ctx: RequestContext) => ConfigurableOperationDefinition[];
    getFulfillmentHandlers(ctx: RequestContext) => ConfigurableOperationDefinition[];
    getActiveShippingMethods(ctx: RequestContext) => Promise<ShippingMethod[]>;
}

constructor​

method
(connection: TransactionalConnection, configService: ConfigService, roleService: RoleService, listQueryBuilder: ListQueryBuilder, channelService: ChannelService, configArgService: ConfigArgService, translatableSaver: TranslatableSaver, customFieldRelationService: CustomFieldRelationService, eventBus: EventBus, translator: TranslatorService) => ShippingMethodService

findAll​

method
(ctx: RequestContext, options?: ListQueryOptions<ShippingMethod>, relations: RelationPaths<ShippingMethod> = []) => Promise<PaginatedList<Translated<ShippingMethod>>>

findOne​

method
(ctx: RequestContext, shippingMethodId: ID, includeDeleted: = false, relations: RelationPaths<ShippingMethod> = []) => Promise<Translated<ShippingMethod> | undefined>

create​

method
(ctx: RequestContext, input: CreateShippingMethodInput) => Promise<Translated<ShippingMethod>>

update​

method
(ctx: RequestContext, input: UpdateShippingMethodInput) => Promise<Translated<ShippingMethod>>

softDelete​

method
(ctx: RequestContext, id: ID) => Promise<DeletionResponse>

assignShippingMethodsToChannel​

method
(ctx: RequestContext, input: AssignShippingMethodsToChannelInput) => Promise<Array<Translated<ShippingMethod>>>

removeShippingMethodsFromChannel​

method
(ctx: RequestContext, input: RemoveShippingMethodsFromChannelInput) => Promise<Array<Translated<ShippingMethod>>>

getShippingEligibilityCheckers​

method
(ctx: RequestContext) => ConfigurableOperationDefinition[]

getShippingCalculators​

method
(ctx: RequestContext) => ConfigurableOperationDefinition[]

getFulfillmentHandlers​

method
(ctx: RequestContext) => ConfigurableOperationDefinition[]

getActiveShippingMethods​

method
(ctx: RequestContext) => Promise<ShippingMethod[]>