Actions65
- Order Actions
- Product Actions
- Store Shipping Account Actions
- Delivery Companies API Actions
- Team User Actions
- Store Actions
- State Actions
- Stop Desk Actions
- City Or Municipality Actions
- Store Client Actions
- Store Coupon Actions
- Store Pro Stock Actions
Stop Desk → Create Stop Desk
AI-generatedSummary
Create a new stop desk in the Dukan system by sending the required stop desk details, either via individual parameters or a raw JSON object.
Inputs
- stopDeskAddress (required) — The address of the stop desk.
- stopDeskShippingPrice (required) — Shipping price for the stop desk, must be 0 or greater.
- allowStopDeskShippingFakePrice (required) — Flag indicating if fake prices for stop desk shipping are allowed.
- locationId (required) — MongoDB ObjectId of the parent state associated with the stop desk.
- stopDeskId — Optional custom identifier for the stop desk.
- stopDeskShippingFakePrice — Optional fake price for stop desk shipping, must be 0 or greater.
- allowDefualtShippingAccount — Optional flag to allow a default shipping account.
- defualtShippingAccount — Optional MongoDB ObjectId of the default shipping account, used if allowDefualtShippingAccount is true.
- isActive — Optional flag indicating whether the stop desk is active; defaults to true.
- useJson — If true, supplies the stop desk data as a raw JSON object instead of individual parameters.
- json — JSON object containing stop desk data with required fields stopDeskAddress, stopDeskShippingPrice, allowStopDeskShippingFakePrice, and locationId; optionally includes stopDeskId, allowDefualtShippingAccount, defualtShippingAccount, stopDeskShippingFakePrice, and isActive.
- forceCustomAuth — Optionally override the configured credentials with a custom API key.
- customApiKey — Custom API key used when forceCustomAuth is enabled.
- forceCustomBaseUrl — Optionally override the Base URL from credentials with a custom Base URL.
- customBaseUrl — Custom Base URL to use for API requests (without the /v1/external suffix), used when forceCustomBaseUrl is enabled.
Output shape
a single record representing the created stop desk as returned from the Dukan API
The output shape corresponds to the API response for creating a stop desk. Authentication and Base URL can be overridden per request using optional parameters. Errors during creation are returned as failure responses.