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

NameTypeDescription
IdintThe ID of the product fulfillment workflow assignment.
ProductIdintThe ID of the product that the fulfillment workflow is assigned to.
Product (via $expand)ProductThe product that the fulfillment workflow is assigned to.
FulfillmentWorkflowIdintThe ID of the fulfillment workflow that is assigned to the product.
FulfillmentWorkflow (via $expand)FulfillmentWorkflowThe fulfillment workflow that is assigned to the product.
IsDefaultWorkflowbooleanFlag that indicates whether this assignment is the default fulfillment workflow for the product. There must always be exactly one default fulfillment workflow per product.
IsConditionalWorkflowbooleanFlag that indicates whether this assignment is a conditional fulfillment workflow for the product.
Namestring

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.

MinQuantityint

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.

MaxQuantityint

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.

IsRushboolean

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.

AccountProductVariantFieldCodestring

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.

ProductVariantFieldValuestring

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.

AccountCustomerFieldCodestring

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.

CustomerFieldValuestring

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.