Dukan icon

Dukan

Interact with the Dukan API

State → Update State

AI-generated

Summary

Update an existing State record in Dukan by its MongoDB ObjectId with specified details, optionally using a JSON payload or individual fields.

Inputs

  • State ID (required) — The MongoDB ObjectId of the state to update.
  • Use JSON — Toggle to define the state data using a JSON object instead of individual fields.
  • JSON — A JSON string representing the state update data when 'Use JSON' is enabled; must conform to UpdateStoreLocationDto format.
  • State Name — The name of the state, up to 50 characters.
  • Shipping To Home Price — The shipping price for delivery to home; minimum 0.
  • State Custom ID — A custom identifier for the state.
  • Is Active — Flag indicating whether the state is active.
  • Allow Shipping To Home Fake Price — Flag to allow use of a fake price for shipping to home.
  • Shipping To Home Fake Price — The fake price for shipping to home; minimum 0, valid only if allowance flag is set.
  • Allow Default Shipping Account — Flag to allow assigning a default shipping account.
  • Default Shipping Account — MongoDB ObjectId of the default shipping account used if allowed.
  • Allow Shipping For Stop Desks Only — Flag indicating whether shipping is permitted only for stop desks.
  • Force Custom Auth Header — Option to use a custom API key instead of node credentials.
  • Custom API Key — Custom API key value used if the custom auth header is forced.
  • Force Custom Base URL — Option to override the base URL from credentials with a custom one.
  • Custom Base URL — Custom base URL for API requests if forced, excluding the /v1/external suffix.

Output shape

a single record

Returns the updated State object as received from the Dukan API upon successful update.

Links

Discussion