Goals for System (WMS) Activities

The Prod Goal Line Group API allows you to create one or more goals for system activities in WFM.

URL

POST ..lgfapi/v10/entity/prod_goal_line_group/

Fields

Name	Required	Type	Description
facility_id	X	Integer	Facility ID
work_area_activity_id	X	Integer	WMS Internal ID of the Work Area Activity
sku_line_group_id	X	Integer	WMS Internal ID of the SKU Line Group
cal_month_id	X	Integer	Values 1 through 12. 1 for JAN, 2 for FEB..... 12 for DEC
cal_year	X	Integer	Four-digit year YYYY; Example 2023
uom_id	X	String	WMS Internal ID of the UOM
uom_per_hr	X	Integer	Qty expected to be handled in one hour (This is the goal)
is_pre_pack	X	Boolean	True or False; Indicates if the item represents a pre-pack

Request Body Example (JSON)

Instance Create

{
    "fields": {
        "facility_id": 648,
        "work_area_activity_id": 573,
        "sku_line_group_id": 22,
        "cal_month_id": 3,
        "cal_year": 2023,
        "uom_id": 2,
        "uom_per_hr": 200,
        "is_pre_pack": true
    }
}

Bulk Create

{
  "options": {
        "commit_frequency": 2
    },
    "fields":[
     {
        "facility_id": 648,
        "work_area_activity_id": 573,
        "sku_line_group_id": 22,
        "cal_month_id": 1,
        "cal_year": 2022,
        "uom_id": 1,
        "uom_per_hr": 750,
        "is_pre_pack": "FALSE"
    },
    {
        "facility_id": 648,
        "work_area_activity_id": 573,
        "sku_line_group_id": 22,
        "cal_month_id": 11,
        "cal_year": 2023,
        "uom_id": 1,
        "uom_per_hr": 750,
        "is_pre_pack": false
    },
    {
        "facility_id": 648,
        "work_area_activity_id": 573,
        "sku_line_group_id": 22,
        "cal_month_id": 12,
        "uom_id": 1,
        "uom_per_hr": 750,
        "is_pre_pack": false
    }
    ]
}

Request Body Example (XML)

Instance Create

<request>
    <fields>
        <facility_id>648</facility_id>
        <work_area_activity_id>553</work_area_activity_id>
        <sku_line_group_id>22</sku_line_group_id>
        <cal_month_id>1</cal_month_id>
        <cal_year>2027</cal_year>
        <uom_id>1</uom_id>
        <uom_per_hr>25</uom_per_hr>
        <is_pre_pack>FALSE</is_pre_pack>
    </fields>
</request>

Bulk Create

<request>
    <fields>
        <list-item>
            <facility_id>648</facility_id>
            <work_area_activity_id>475</work_area_activity_id>
            <sku_line_group_id>22</sku_line_group_id>
            <cal_month_id>1</cal_month_id>
            <cal_year>2023</cal_year>
            <uom_id>1</uom_id>
            <uom_per_hr>20</uom_per_hr>
            <is_pre_pack>FALSE</is_pre_pack>
        </list-item>
        <list-item>
            <facility_id>648</facility_id>
            <work_area_activity_id>292</work_area_activity_id>
            <sku_line_group_id>42</sku_line_group_id>
            <cal_month_id>2</cal_month_id>
            <cal_year>2026</cal_year>
            <uom_id>2</uom_id>
            <uom_per_hr>200</uom_per_hr>
            <is_pre_pack>TRUE</is_pre_pack>
        </list-item>
        <list-item>

Note: If the options parameter "commit_frequency" is not provided in the payload, the behavior defaults to same behavior as commit_frequency = 0, which is a all or nothing functionality. In other words, either all records are processed (if successful) or none of the records are processed even if 1 record fails validations.