Supply Planning

The table below list the data entities and columns used by Supply Planning.

Note

How to read the table:

Required – The column name is mandatory in your dataset and you must populate the column name with values.
Optional – The column name is optional. For enhanced feature output, it is recommended to add the column name with values.
Not required – Data entity not required.

Data entity	Column	Is the column used for Auto Replenishment?	Is the column used for Manufacturing Plan?
site	id	Required	Required
	description	Required	Required
	geo_id	Required - Without this field, filters cannot group sites by category such as region, country, state, zip code and so on.	Required - Without this field, filters cannot group sites by category such as region, country, state, zip code and so on.
	site_type	NA	NA
	company_id	Optional	Optional
	latitude	NA	NA
	longitude	NA	NA
	is_active	Required - Identifies if a site needs to be considered for planning. Note, set the value to False if a site should not to be considered. If the field is kept blank or null, the site will be considered.	Required - Identifies if a site needs to be considered for planning. Note, set the value to False if a site should not to be considered. If the field is kept blank or null, the site will be considered.
	open_date	NA	NA
	end_date	NA	NA
transportation_lane	id	Required	Required
	from_site_id	Required	Required
	to_site_id	Required	Required
	product_group_id	Required	Required
	transit_time	Required	Required
	time_uom	Required - Supported values include Day.	Required - Supported values include Day.
	distance	Not required	Not required
	distance_uom	Not required	Not required
	eff_start_date	Optional	Optional
	eff_end_date	Optional	Optional
	product_id	Optional	Optional
	emissions_per_unit	Not required	Not required
	emissions_per_weight	Not required	Not required
	company_id	Optional	Optional
	from_geo_id	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	to_geo_id	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	carrier_tpartner_id	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	service_type	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	trans_mode	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	cost_per_unit	Optional	Optional
	cost_currency	Optional	Optional
product	id	Required	Required
	description	Required	Required
	product_group_id	Required - Without this field, filters cannot group by product category such as dairy, clothes, and so on.	Required - Without this field, filters cannot group by product category such as dairy, clothes, and so on.
	is_deleted	Required - Identifies if a product needs to be considered for planning. Set the field to False to consider this product and True to not consider the product. If this field is left blank or null, then the value will be defaulted to True.	Required - Identifies if a product needs to be considered for planning. Set the field to False to consider this product and True to not consider the product. If this field is left blank or null, then the value will be defaulted to True.
	product_type	Not required	Not required
	parent_product_id	Optional	Optional
	base_uom	Optional	Optional
	unit_cost	Optional	Optional
	unit_price	Optional	Optional
product_hierarchy	id	Required	Required
	description	Required – This field is used by filters to group by a product category such as dairy, clothes, and so on.	Required – This field is used by filters to group by a product category such as dairy, clothes, and so on.
	parent_product_group_id	Optional – This field is used by filters to support multiple product category hierarchy such as dairy, full fat milk and so on.	Optional – This field is used by filters to support multiple product category hierarchy such as dairy, full fat milk and so on.
geography	id	Required	Required
	description	Required	Required
	parent_geo_id	Optional – This field is used by filters to support multiple location hierarchy such as USA → USA-EAST.	Optional – This field is used by filters to support multiple location hierarchy such as USA → USA-EAST.
trading_partner	id	Required	Required
	description	Optional	Optional
	country	Optional	Optional
	eff_start_date	Required – You must enter a value for eff_start_date and eff_end_date. If you don't have a value, enter `1900-01-01 00:00:00` for eff_start_date, and `9999-12-31 23:59:59` for eff_end_date.	Required – You must enter a value for eff_start_date and eff_end_date. If you don't have a value, enter `1900-01-01 00:00:00` for eff_start_date, and `9999-12-31 23:59:59` for eff_end_date.
	eff_end_date	Required – You must enter a value for eff_start_date and eff_end_date. If you don't have a value, enter `1900-01-01 00:00:00` for eff_start_date, and `9999-12-31 23:59:59` for eff_end_date.	Required – You must enter a value for eff_start_date and eff_end_date. If you don't have a value, enter `1900-01-01 00:00:00` for eff_start_date, and `9999-12-31 23:59:59` for eff_end_date.
	time_zone	Optional	Optional
	is_active	Optional	Optional
	tpartner_type	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	geo_id	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
inbound_order	id	Required	Required
	order_type	Required	Required
	order_status	Not required	Not required
	to_site_id	Not required	Not required
	submitted_date	Optional	Optional
	tpartner_id	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
inbound_order_line	id	Required	Required
	order_id	Required	Required
	order_type	Required	Required
	status	Not required	Not required
	product_id	Required	Required
	to_site_id	Required	Required
	from_site_id	Not required	Not required
	quantity_submitted	Required – You must set one quantity field.	Required – You must set one quantity field.
	quantity_confirmed	Optional – You must set one quantity field.	Optional – You must set one quantity field.
	quantity_received	Optional – You must set one quantity field.	Optional – You must set one quantity field.
	expected_delivery_date	Required	Required
	submitted_date	Not required	Not required
	incoterm	Not required	Not required
	company_id	Optional	Optional
	tpartner_id	Required – This field is required for successful ingestion.	Required – This field is required for successful ingestion.
	quantity_uom	Not required	Not required
	reservation_id	Not required	Not required
	reference_object_type	Optional – This field is used for associating purchase order requests to purchase orders to track plan to PO conversion in the ERP.	Optional – This field is used for associating purchase order requests to purchase orders to track plan to PO conversion in the ERP.
	reference_object_id	Optional – This field is used for associating purchase order requests to purchase orders to track plan to PO conversion in the ERP.	Optional – This field is used for associating purchase order requests to purchase orders to track plan to PO conversion in the ERP.
inv_policy	site_id	Required	Required
	id	Required	Required
	dest_geo_id	Required	Required
	product_id	Optional – Either product_id or product_group_id is required.	Optional – Either product_id or product_group_id is required.
	product_group_id	Optional – Either product_id or product_group_id is required.	Optional – Either product_id or product_group_id is required.
	eff_start_date	Required	Required
	eff_end_date	Required	Required
	company_id	Optional	Optional
	ss_policy	Required – The accepted values for this field are abs_level, doc_dem, doc_fcst, and sl.	Required – The accepted values for this field are abs_level, doc_dem, doc_fcst, and sl.
	target_inventory_qty	Required – This field is required when ss_policy is set to abs_level.	Required – This field is required when ss_policy is set to abs_level.
	target_doc_limit	Required – This field is required when ss_policy is set to doc_dem or doc_fcst.	Required – This field is required when ss_policy is set to doc_dem or doc_fcst.
target_sl	Required – This field is required when ss_policy is set to sl.	Required – This field is required when ss_policy is set to sl.
sourcing_rules	sourcing_rule_id	Required	Required
	company_id	Optional	Optional
	product_id	Optional – Either product_id or product_group_id is required.	Optional – Either product_id or product_group_id is required.
	product_group_id	Optional – Either product_id or product_group_id is required.	Optional – Either product_id or product_group_id is required.
	from_site_id	Optional – This field is required for sourcing_rule types transfer.	Optional – This field is required for sourcing_rule types transfer.
	to_site_id	Required	Required
	sourcing_rule_type	Required – The allowed values for this field are transfer, buy, and manufacture.	Required – The allowed values for this field are transfer, buy, and manufacture.
	tpartner_id	Optional – This field is required for sourcing_rule types buy.	Optional – This field is required for sourcing_rule types buy.
	transportation_lane_id	Optional – This field is required for sourcing_rule types transfer.	Optional – This field is required for sourcing_rule types transfer.
	production_process_id	Optional – This field is required for sourcing_rule types manufacture.	Optional – This field is required for sourcing_rule types manufacture.
	sourcing_priority	Optional	Optional
	min_qty	Optional	Optional
	max_qty	Optional	Optional
	qty_multiple	Optional	Optional
	eff_start_date	Required	Required
	eff_end_date	Required	Required
sourcing_schedule Note This data entity is optional.	sourcing_schedule_id	Required	Required
	company_id	Optional	Optional
	tpartner_id	Optional – This field is required for schedule_type InboundOrdering.	Optional – This field is required for schedule_type InboundOrdering.
	status	Required	Required
	from_site_id	Optional – This field is required for schedule_type OutboundShipping.	Optional – This field is required for schedule_type OutboundShipping.
	to_site_id	Required	Required
	schedule_type	Required – The allowed values for this field are InboundOrdering and OutboundShipping.	Required – The allowed values for this field are InboundOrdering and OutboundShipping.
	eff_start_date	Required	Required
	eff_end_date	Required	Required
sourcing_schedule_details Note This data entity is optional.	sourcing_schedule_detail_id	Required	Required
	sourcing_schedule_id	Required	Required
	company_id	Optional	Optional
	product_id	Optional – Either product_id or product_group_id is required.	Optional – Either product_id or product_group_id is required.
	product_group_id	Optional – Either product_id or product_group_id is required.	Optional – Either product_id or product_group_id is required.
	day_of_week	Optional	Optional
	week_of_month	Optional	Optional
	time_of_day	Optional	Optional
	date	Optional	Optional
product_bom	id	Not required	Required
	product_id	Not required	Required
	company_id	Optional	Optional
	site_id	Not required	Required
	production_process_id	Not required	Required
	component_product_id	Not required	Required
	component_quantity_per	Not required	Required
	assembly_cost	Not required	Optional
	assembly_cost_uom	Not required	Optional
	priority	Not required	Optional
	eff_start_date	Not required	Required
	eff_end_date	Not required	Required
production_process	production_process_id	Not required	Required
	production_process_name	Not required	Optional
	product_id	Not required	Required
	site_id	Not required	Required
	company_id	Optional	Optional
	setup_time	Not required	Optional
	setup_time_uom	Not required	Optional
	operation_time	Not required	Optional
	operation_time_uom	Not required	Optional
inv_level	snapshot_date	Required	Required
	site_id	Required	Required
	product_id	Required	Required
	company_id	Optional	Optional
	on_hand_inventory	Required	Required
	allocated_inventory	Not required	Not required
	bound_inventory	Not required	Not required
	lot_number	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	expiry_date	Not required	Not required
forecast	site_id	Required	Required
	product_id	Required	Required
	mean	Optional	Optional
	p10	Optional	Optional
	p50	Optional	Optional
	p90	Optional	Optional
	forecast_start_dttm	Required	Required
	forecast_end_dttm	Required	Required
	snapshot_date	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	region_id	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	product_group_id	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
vendor_product	company_id	Optional	Optional
	vendor_tpartner_id	Required	Required
	product_id	Required	Required
	eff_start_date	Required	Required
	eff_end_date	Required	Required
vendor_lead_time	company_id	Optional	Optional
	vendor_tpartner_id	Required	Required
	product_id	Optional	Optional
	site_id	Required	Required
	planned_lead_time	Required	Required
	eff_start_date	Required	Required
	eff_end_date	Required	Required
	product_group_id	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
	region_id	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	Required – When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.
outbound_order_line	id	Required – This field determines the outbound shipment id.	Required – This field determines the outbound shipment id.
	product_id	Required – This field determines the id of the product shipped.	Required – This field determines the id of the product shipped.
	cust_order_id	Required – This field determines the id of the outbound order.	Required – This field determines the id of the outbound order.
	ship_from_site_id	Required – This field determines the site from where the product units are requested.	Required – This field determines the site from where the product units are requested.
	ship_to_site_id	Not required	Not required
	init_quantity_requested	Optional – This field determines the final quantity after any cancellations and changes.	Optional – This field determines the final quantity after any cancellations and changes.
	quantity_promised	Optional	Optional
	quantity_delivered	Optional – This field displays the actual quantity delivered.	Optional – This field displays the actual quantity delivered.
	status	Optional – This field determines the status of the order line, that is, canceled, open, closed, and so on.	Optional – This field determines the status of the order line, that is, canceled, open, closed, and so on.
	requested_delivery_date	Required	Required
	promised_delivery_date	Optional	Optional
	actual_delivery_date	Optional	Optional
segmentation	segment_id	Required	Required
	creation_date	Required	Required
	company_id	Optional	Optional
	site_id	Required	Required
	product_id	Required	Required
	segment_description	Optional	Optional
	segment_type	Optional	Optional
	segment_value	Optional	Optional
	source	Optional	Optional
	eff_start_date	Required	Required
	eff_end_date	Required	Required
company Note This data entity is optional.	id	Required	Required
	description	Optional	Optional
	address_1	Optional	Optional
	address_2	Optional	Optional
	address_3	Optional	Optional
	city	Optional	Optional
	state_prov	Optional	Optional
	postal_code	Optional	Optional
	country	Optional	Optional
	phone_number	Optional	Optional
	time_zone	Optional	Optional
	calendar_id	Optional	Optional
shipment	id	Required	NA
	ship_to_site_id	Required	NA
	product_id	Required	NA
	ship_from_site_id	Required – Supply Planning can use the value from ship_from_site_id or supplier_tpartner_id.	NA
	supplier_tpartner_id	Required – Supply Planning can use the value from ship_from_site_id or supplier_tpartner_id.	NA
	order_type	Required	NA
	units_shipped	Required	NA
	planned_delivery_date	Required – Supply Planning can use the value from planned_delivery_date, actual_delivery_date, or carrier_eta_date.	NA
	actual_delivery_date
	carrier_eta_date
	planned_ship_date	Required – Supply Planning can use the value from planned_ship_date, or actual_ship_date.	NA
	actual_ship_date		NA
	creation_date	Optional	NA
	shipment_status	Optional	NA
	order_id	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	NA
	order_line_id
	package_id
shipment_lot	id	Required	NA
	lot_qty	Required	NA
	expiry_date	Optional	NA
	shipment_id	Required	NA
	product_id	Required. When you ingest data from SAP or EDI, the default value for string is SCN_RESERVED_NO_VALUE_PROVIDED. When you upload data using the Amazon S3 connector, you must enter a value or use SCN_RESERVED_NO_VALUE_PROVIDED for successful ingestion.	NA
	tpartner_id
	order_id
	order_line_id
	package_id

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

N-Tier Visibility

Insights