Skip to main content

updateFulfillmentRule

Updates an existing fulfillment rule.

Business Rules​

  • The fulfillment rule must exist within the current company.
  • At least one field must be sent. An omitted field is left unchanged.
  • The name, if provided, must be unique within the company.
  • The description and the fulfillment integration are cleared by passing null.

Error Scenarios​

  • **NOT_FOUND**: when the company, the fulfillment rule, or the fulfillment integration does not exist.
  • **BAD_REQUEST**: when no field is sent, the name is blank, too long, or already in use, or the decomposition strategy is blank.

Permissions Required​

  • orders:update_fulfillment_profile permission
updateFulfillmentRule(
  input: UpdateFulfillmentRuleInput!
): FulfillmentRule

Arguments​

updateFulfillmentRule.input ● UpdateFulfillmentRuleInput! non-null input common​

Parameters for UpdateFulfillmentRule

Type​

FulfillmentRule object orders​

Fulfillment Rule​

A reusable set of rules that defines how a fulfillment is processed. A fulfillment rule is owned by a company and is assigned to fulfillments to govern how they progress through the fulfillment state machine.