Skip to main content

surchargeUpdate

Update an existing surcharge's configuration.

Modifies surcharge details including amounts, calculation rules, and settings. Only provided fields will be updated, others remain unchanged.

Possible errors:

  • FORBIDDEN: Insufficient permissions to update surcharges
  • UPDATE_SURCHARGE_INPUT_VALIDATION_ERROR: No parameters provided for update
  • NOT_FOUND_SURCHARGE_ERROR: Surcharge with the provided ID was not found
  • GET_SURCHARGE_ERROR: Database access errors while fetching the surcharge to update
  • UPDATE_SURCHARGE_ERROR: Database update failures or general errors while updating the surcharge

AUTH: Role=[pricing.OWNER,pricing.EDITOR]

surchargeUpdate(
  id: String!
  input: UpdateSurchargeInput!
): Surcharge!

Arguments​

surchargeUpdate.id ● String! non-null scalar​

Unique identifier of the surcharge to update.

Must be a valid string representing an existing surcharge in the system.

surchargeUpdate.input ● UpdateSurchargeInput! non-null input​

Updated surcharge information.

Contains the surcharge properties to update. Only provided fields will be changed, others remain unchanged.

Type​

Surcharge object​

Surcharge entity representing additional fees and charges in the pricing system.

Contains comprehensive surcharge information including calculation rules, localized content, tax configuration, and validity periods. Used for dynamic pricing calculations and order processing.