Create a Delivery Workflow step

post

https://example.com/integration-tenants/api/v1/order-profiles/{profileId}/workflows/delivery/steps

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profileId

string

required

Body Params

workflowStepType

int32

enum

required

[0 - 'Id', 1 - 'COD', 2 - 'Image', 3 - 'Signature', 4 - 'UserField', 5 - 'Barcode', 6 - 'ParcelType', 7 - 'Weight', 8 - 'Dimension', 9 - 'Description', 10 - 'Tip', 11 - 'DocumentSignature']

workflowStepState

int32

enum

required

[0 - 'HiddenOnCreateOrder', 1 - 'ActiveByDefault', 2 - 'InactiveByDefault']

Allowed:

titlePrimary

string

required

length between 1 and 256

titleSecondary

string | null

descriptionPrimary

string | null

descriptionSecondary

string | null

driverInstructionsPrimary

string | null

driverInstructionsSecondary

string | null

canSkip

boolean

tag

string | null

partialCODEnabled

boolean

COD steps only. Whether partial COD collection is enabled.

partialCODState

int32

enum

[0 - 'ActiveByDefault', 1 - 'InactiveByDefault']

Allowed:

userFieldId

string | null

Used by User field steps or Image steps with Dispatch.Integration.Tenants.Api.Models.Requests.Workflows.CreateWorkflowStepRequest.FeedUserFieldWithAI enabled).

attachmentSourceOptions

array of objects | null

Used by Image steps only. The sources from which the driver is allowed to provide an attachment.
At least one source is required for an Image step.

attachmentSourceOptions

Allowed:

onlyAllowTakingOnePicture

boolean

Used by Image steps only. Whether the driver can only take a single picture.

includeWithInvoice

boolean

Used by Image steps only. Whether the captured image is included with the invoice.

feedUserFieldWithAI

boolean

Used by Image steps only. Whether the captured image feeds a user field through AI.
Requires Dispatch.Integration.Tenants.Api.Models.Requests.Workflows.CreateWorkflowStepRequest.OnlyAllowTakingOnePicture to be enabled.

prompt

string | null

Used by Image steps only. The AI prompt used when Dispatch.Integration.Tenants.Api.Models.Requests.Workflows.CreateWorkflowStepRequest.FeedUserFieldWithAI is enabled.

exceptionCodeTypeId

string | null

Used by Image steps only. The exception code type id used when Dispatch.Integration.Tenants.Api.Models.Requests.Workflows.CreateWorkflowStepRequest.FeedUserFieldWithAI is enabled.

allowAddingMultipleItems

boolean

Used by Barcode steps only. Whether the driver can add multiple items.

allowedBarcodeFormatRegex

string | null

Used by Barcode steps only. A regular expression the scanned barcode must match.

document

object

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200

Delivery workflow step created successfully

404

Not Found

400The request is invalid