Attributes in the Response Payload
Get details about attributes that the ConfiguredItemService web service returns in the response payload.
Structure of the Sales Order
Here are the attributes that the response payload includes when you get the structure of the sales order.
|
Attribute |
Type |
Description |
|---|---|---|
|
ConfigItemId |
Long |
Value that identifies the configuration item that the flow creates. |
|
ConfigItemNumber |
String |
Number that identifies the configured item. |
|
BaseModelId |
Long |
Value that identifies the inventory item for the assemble-to-order model that your user uses to choose the configure options. |
|
BaseModelItemNumber |
String |
Number that identifies the name of the assemble-to-order model. |
|
InventoryItemId |
Long |
Value that identifies the inventory item for the line item. |
|
InventoryItemNumber |
String |
Number that identifies Item name of the line item. |
|
ParentInventoryItemId |
Long |
Value that identifies the parent of the inventory item. |
|
ParentInventoryItemNumber |
String |
Number that identifies the name of the parent of the inventory item. |
|
HeaderId |
Long |
Value that identifies the match header record. |
|
LineId |
Long |
Value that uniquely identifies the line assigned to the match detail record. |
|
ParentLineId |
Long |
Value that identifies the line that represents the immediate parent item of the component. |
|
SubItemType |
Long |
Value that identifies the type of sub item. The attribute value is 1, 2, or 4. 1. Assemble-to-order item. 2. Option class. 4. Configure option. |
|
UnitQuantity |
BigDecimal |
Quantity needed to make one unit of the top level assembly. |
|
UnitUOM |
String |
Unit of measure for the quantity. |
|
ItemHierarchy |
String |
Hierarchy of inventory item identifiers, separated by a forward slash ( / ). |
|
CreationDate |
Timestamp |
Date when the user created the configured item. |
|
RootHeaderId |
Long |
Value that identifies the header of the top level assemble-to-order item. |
Structure of the Entire Instance
Here are the attributes that the response includes when you get the structure of the entire instance. The response also includes the same attributes for the structure of the sales order except for ItemHierarchy and RootHeaderId.
|
Attribute |
Type |
Description |
|---|---|---|
|
RevisionId |
Long |
Value that identifies the item revision. |
|
EffectivityDate |
Timestamp |
Date when the item or component goes into effect. |
|
DisableDate |
Timestamp |
Date when the flow disables the item or component. |
|
OrganizationId |
Long |
Value that identifies the organization of the inventory item. |
|
OrganizationCode |
String |
Abbreviation that identifies the organization of the inventory item. |
|
BillSequenceId |
Long |
Value that identifies the bill sequence for the assemble-to-order model. The structure of the configuration model defines the sequence. |
|
ComponentSequenceId |
Long |
Value that identifies the sequence for the selected component. The structure of the configuration model defines the sequence. |
|
ComponentType |
String |
The type of component. Contains 1 or -1 (negative value of 1). 1. Assembled component. -1. Component that isn't assembled. Its typically part of an assembled component. |
|
WIPSupplyType |
BigDecimal |
Type of supply that's work-in-process. The structure of the configuration model defines the type. |
|
OptionalComponent |
String |
Contains Y or N. Y. The component is optional. N. The component is required. |
|
SubstituteComponent |
String |
Contains Y or N. Y. The component is a substitute. N. The component isn't a substitute. |
|
ComponentYieldFactor |
BigDecimal |
Multiplication factor the flow uses to determine the quantity needed to fulfill the component. The structure of the configuration model defines the factor. |
|
PlanningFactor |
BigDecimal |
Multiplication factor the flow uses to determine the quantity needed to plan the component. The structure of the configuration model defines the factor. |
|
RoundingDirection |
BigDecimal |
Specifies the rounding direction as up or down. The structure of the configuration model defines the direction. |
|
BasisType |
BigDecimal |
Specifies whether the value is an item. The value 1 specifies its an item. |
|
CheckATP |
BigDecimal |
Specify whether to run available-to-promise rule. Contains 1 or 2. 1. Run rule. 2. Don't run rule. The structure of the configuration model determines whether to run the rule. |
|
ComponentHierarchy |
String |
Hierarchy of the components in the configuration model. It's a hierarchical list of identifiers, where a dash ( - ) separates each identifier. |
|
ComponentItemHierarchy |
String |
Hierarchy of the inventory items in the configuration model. It's a hierarchical list of identifiers, where a dash ( - ) separates each identifier. |
|
ItemClassId |
Long |
Value that identifies the item class of the configured item. |
|
RootPhantomItemId |
Long |
Value that uniquely identifies the phantom of a subassembly item. |
Transaction Attribute
Here are the attributes that the response contains when your payload includes a transaction attribute.
|
Attribute |
Type |
Description |
|---|---|---|
|
LineId |
Long |
Value that uniquely identifies the order line. |
|
AttributeName |
String |
Name of the transaction attribute. |
|
CharacterAttributeValue |
String |
Contains the character value of the transaction attribute. |
|
NumberAttributeValue |
Long |
Contains the number value of the transaction attribute. |
|
DateAttributeValue |
Date |
Contains the date value of the transaction attribute. |
|
TimestampAttributeValue |
Timestamp |
Contains the time stamp value of the transaction attribute. |