Dukan icon

Dukan

Interact with the Dukan API

Store Shipping Account → Update

AI-generated

Summary

Update a store shipping account in Dukan by specifying its MongoDB ObjectId and providing fields to modify either via individual parameters or a JSON object.

Inputs

  • Shipping Account ID (required) — The MongoDB ObjectId identifying the shipping account to update.
  • Use JSON — Toggle to define update data via a JSON object instead of individual fields.
  • JSON — A JSON object containing fields to update such as aliasName, shipDirectly, isActive, apiEndpoint1-3, and apiKey1-6; used if 'Use JSON' is enabled.
  • Alias Name — Optional display name for the shipping account, used if 'Use JSON' is disabled.
  • Ship Directly — Optional boolean indicating if the shipping account ships directly, used if 'Use JSON' is disabled.
  • Is Active — Optional boolean to set the account's active status, used if 'Use JSON' is disabled.
  • Force Custom Auth Header — Use a custom API key from this node instead of the stored credentials.
  • Custom API Key — API key to send with requests when forcing custom authentication.
  • Force Custom Base URL — Use a custom base URL for API requests instead of the credential's base URL.
  • Custom Base URL — Base URL to use for API requests, without the /v1/external suffix, when forcing a custom base URL.

Output shape

a single JSON object representing the updated store shipping account returned by the Dukan API

The output contains the updated store shipping account details after successful update; errors are returned as per Dukan API response conventions.

Examples

Example 1: Updating aliasName and isActive status using individual fields

Provide Shipping Account ID, set Use JSON to false, then set Alias Name and Is Active fields.

Example 2: Updating multiple fields using JSON

Provide Shipping Account ID, set Use JSON to true, and provide a JSON string with fields like aliasName and apiKey1 to update.

Links

Discussion