Fulfillment/GraphQL

Fulfillment/GraphQL

Source:

Fulfillment related GraphQL resolvers

Methods

(static) "Mutation.createFlatRateFulfillmentMethod"(parentResult, context) → {Promise.<Object>}

resolver for the createFlatRateFulfillmentMethod GraphQL mutation

Source:
Parameters:
Name Type Description
parentResult Object

unused

args.input Object

an object of all mutation arguments that were sent by the client

Properties
Name Type Attributes Description
method Object

The method object

shopId String

The shop to create this flat rate fulfillment method for

clientMutationId String <optional>

An optional string identifying the mutation call

context Object

an object containing the per-request state

Returns:

CreateFlatRateFulfillmentMethodPayload

Type
Promise.<Object>

(static) "Mutation.deleteFlatRateFulfillmentMethod"(parentResult, context) → {Promise.<Object>}

resolver for the deleteFlatRateFulfillmentMethod GraphQL mutation

Source:
Parameters:
Name Type Description
parentResult Object

unused

args.input Object

an object of all mutation arguments that were sent by the client

Properties
Name Type Attributes Description
methodId String

The ID of the method you want to delete

shopId String

The shop to delete this flat rate fulfillment method for

clientMutationId String <optional>

An optional string identifying the mutation call

context Object

an object containing the per-request state

Returns:

DeleteFlatRateFulfillmentMethodPayload

Type
Promise.<Object>

(static) "Mutation.deleteFlatRateFulfillmentRestriction"(parentResult, context) → {Promise.<Object>}

resolver for the deleteFlatRateFulfillmentRestriction GraphQL mutation

Source:
Parameters:
Name Type Description
parentResult Object

unused

args.input Object

an object of all mutation arguments that were sent by the client

Properties
Name Type Attributes Description
restrictionId String

The ID of the restriction you want to delete

shopId String

The shop to delete this restriction for

clientMutationId String <optional>

An optional string identifying the mutation call

context Object

an object containing the per-request state

Returns:

DeleteFlatRateFulfillmentRestrictionPayload

Type
Promise.<Object>

(static) "Mutation.updateFlatRateFulfillmentMethod"(parentResult, context) → {Promise.<Object>}

resolver for the updateFlatRateFulfillmentMethod GraphQL mutation

Source:
Parameters:
Name Type Description
parentResult Object

unused

args.input Object

an object of all mutation arguments that were sent by the client

Properties
Name Type Attributes Description
methodId String

The ID of the method you want to update

method Object

The full updated method object, without ID

shopId String

The shop to update this flat rate fulfillment method for

clientMutationId String <optional>

An optional string identifying the mutation call

context Object

an object containing the per-request state

Returns:

UpdateFlatRateFulfillmentMethodPayload

Type
Promise.<Object>

(static) "Mutation.updateFlatRateFulfillmentRestriction"(parentResult, context) → {Promise.<Object>}

resolver for the updateFlatRateFulfillmentRestriction GraphQL mutation

Source:
Parameters:
Name Type Description
parentResult Object

unused

args.input Object

an object of all mutation arguments that were sent by the client

Properties
Name Type Attributes Description
restrictionId String

The ID of the restriction you want to update

restriction Object

The full updated restriction object, without ID

shopId String

The shop to update this flat rate fulfillment restriction for

clientMutationId String <optional>

An optional string identifying the mutation call

context Object

an object containing the per-request state

Returns:

updateFlatRateFulfillmentRestrictionPayload

Type
Promise.<Object>

(static) "Mutation/createFlatRateFulfillmentMethod"(parentResult, context) → {Promise.<Object>}

resolver for the createFlatRateFulfillmentMethod GraphQL mutation

Source:
Parameters:
Name Type Description
parentResult Object

unused

args.input Object

an object of all mutation arguments that were sent by the client

Properties
Name Type Attributes Description
restriction Object

The restriction object

shopId String

The shop to create this flat rate fulfillment method for

clientMutationId String <optional>

An optional string identifying the mutation call

context Object

an object containing the per-request state

Returns:

CreateFlatRateFulfillmentMethodPayload

Type
Promise.<Object>

(static) "Query.getFlatRateFulfillmentRestriction"(parentResult, args, args, context) → {Promise.<Object>|undefined}

resolver for the getFlatRateFulfillmentRestriction GraphQL mutation

Source:
Parameters:
Name Type Description
parentResult Object

unused

args Object

an object of all arguments that were sent by the client

Properties
Name Type Description
shopId String

The shop that owns this restriction

args ConnectionArgs

an object of all arguments that were sent by the client

context Object

an object containing the per-request state

Returns:

A Restriction object

Type
Promise.<Object> | undefined

(static) "Query.getFlatRateFulfillmentRestrictions"(parentResult, args, args, context) → {Promise.<Object>|undefined}

resolver for the getFlatRateFulfillmentRestrictions GraphQL mutation

Source:
Parameters:
Name Type Description
parentResult Object

unused

args Object

an object of all arguments that were sent by the client

Properties
Name Type Description
shopId String

The shop that owns these restriction

args ConnectionArgs

an object of all arguments that were sent by the client

context Object

an object containing the per-request state

Returns:

A Restriction object

Type
Promise.<Object> | undefined