ProductFulfillmentWorkflow

A ProductFulfillmentWorkflow represents an assignment of a FulfillmentWorkflow to a Product.

Note: The default FulfillmentWorkflow for a product is also specified as a property (FulfillmentWorkflowId) of the Product resource.

Properties

Name

Type

Description

Id

int

The ID of the product fulfillment workflow assignment.

ProductId

int

The ID of the product that the fulfillment workflow is assigned to.

Product (via $expand)

Product

The product that the fulfillment workflow is assigned to.

FulfillmentWorkflowId

int

The ID of the fulfillment workflow that is assigned to the product.

FulfillmentWorkflow (via $expand)

FulfillmentWorkflow

The fulfillment workflow that is assigned to the product.

IsDefaultWorkflow

boolean

Flag that indicates whether this assignment is the default fulfillment workflow for the product. There must always be exactly one default fulfillment workflow per product.

IsConditionalWorkflow

boolean

Flag that indicates whether this assignment is a conditional fulfillment workflow for the product.

Name

string

The name of the product fulfillment workflow assignment.

This value is for conditional fulfillment workflow assignments only. This value will be null for default fulfillment workflow assignments.

MinQuantity

int

The minimum quantity required in order to use this fulfillment workflow. If there is no minimum quantity, this value will be null.

This value is for conditional fulfillment workflow assignments only. This value will be null for default fulfillment workflow assignments.

MaxQuantity

int

The maximum quantity required in order to use this fulfillment workflow. If there is no maximum quantity, this value will be null.

This value is for conditional fulfillment workflow assignments only. This value will be null for default fulfillment workflow assignments.

IsRush

boolean

Flag that indicates the rush status required in order to use this fulfillment workflow. If there is no rush requirement, this value will be null.

This value is for conditional fulfillment workflow assignments only. This value will be null for default fulfillment workflow assignments.

AccountProductVariantFieldCode

string

The code of the custom product field that is required in order to use this fulfillment workflow. If there is no custom product field requirement, this value will be null.

This value is for conditional fulfillment workflow assignments only. This value will be null for default fulfillment workflow assignments.

ProductVariantFieldValue

string

The value of the custom product field that is required in order to use this fulfillment workflow. If there is no custom product field requirement, this value will be null.

This value is for conditional fulfillment workflow assignments only. This value will be null for default fulfillment workflow assignments.

AccountCustomerFieldCode

string

The code of the custom customer field that is required in order to use this fulfillment workflow. If there is no custom customer field requirement, this value will be null.

This value is for conditional fulfillment workflow assignments only. This value will be null for default fulfillment workflow assignments.

CustomerFieldValue

string

The value of the custom customer field that is required in order to use this fulfillment workflow. If there is no custom customer field requirement, this value will be null.

This value is for conditional fulfillment workflow assignments only. This value will be null for default fulfillment workflow assignments.