Assign
The Product/Product Group – Assign API call attempts to assign a Product to a Product Group.
Figure 1 shows the logic used within the Product/Product Group – Assign API call.
Figure 1 - Logic within Product_ProductGroup/Assign API Call
Prerequisites
When assigning a Product to a Product Group, both the Product and Product Group must exist in Eyelit MES-M.
Request
Table 1 shows the method and endpoint required to make the API call to list Product Groups.
Table 1 - Outbound Message Detail for Product Group - Delete
Method | URL Structure | Endpoint |
PUT | https://[environment].mestec.net | /api/Product_ProductGroup/Assign |
The body of the payload should follow the format below.
See Table 2 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 2 - Parameter Information for Product Group - Delete
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
Product Group ID | productgroup.id | NUMBER | No | N/A | Exact |
Product ID | product.id | NUMBER | No | N/A | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
Assign by ID
Response
When using the Product/Product Group – Assign API call, if a Product has been assigned from a Product Group, a JSON payload will be returned containing data in the following structure:
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
Unassign
The Product/Product Group – Unassign API call attempts to unassign a Product from a Product Group.
Figure 2 shows the logic used within the Product/Product Group – Unassign API call.
Figure 2 - Logic within Product_ProductGroup/Unassign API Call
Prerequisites
When unassigning a Product from a Product Group, both the Product and Product Group must exist in Eyelit MES-M, Additionally, the Product must be assigned to the Product Group.
Request
Table 3 shows the method and endpoint required to make the API call to unassign a Product from a Product Group.
Table 3 - Outbound Message Detail for Product Group - Delete
Method | URL Structure | Endpoint |
PUT | https://[environment].mestec.net | /api/Product_ProductGroup/Unassign |
The body of the payload should follow the format below.
See Table 4 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 4 - Parameter Information for Product Group - Delete
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
Product Group ID | productgroup.id | NUMBER | No | N/A | Exact |
Product ID | product.id | NUMBER | No | N/A | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
Unassign by ID
Response
When using the Product/Product Group – Unassign API call, if a Product has been unassigned from a Product Group, a JSON payload will be returned containing data in the following structure:
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
