Introduction
This document describes how the integration Web Service can be implemented by the customer so that MPS can communicate with the system being integrated.
The integration of the MPS Portal with the MPSOrdersNotification Web Service is a feature available starting with version 5.3, which enables a third-party system to receive notifications from the MPS Portal regarding changes to orders and deliveries assigned to Distribution Centers and Suppliers.
The Web Service must be implemented in accordance with the methods described below so that the MPS Portal can execute them when a Distribution Center or a Supplier experiences changes in orders and deliveries related to them. This must be configured individually within the system. It must also be published on a server with an IP address or domain name that can be called by the MPS Portal server. After publication, the partner must configure the address where the Web Service was published in the MPS Portal, as well as configure the methods to be called according to the desired status changes, and define which fields to include or exclude in the Web Service call package.
The name of the virtual folder where the Web Service will be published and the name of the asmx class can be changed, but it is recommended to use the same ones found in the sample project.
Methods that can be implemented as needed
No method is required to be implemented; you can write only the ones you want the system to access. They will be called based on the current status and whether they have been marked in the MPS Portal to be called.
This call will contain data in JSON format, which can be customized in the MPS Portal by specifying which fields to send.
|
Method |
Description |
|
You will be notified by the MPS Portal when a new order is placed for the Distribution Center or Supplier |
|
|
You will be notified by the MPS Portal when an order assigned to the Distribution Center or Supplier is processed |
|
|
You will be notified by the MPS Portal when an order assigned to the Distribution Center is invoiced |
|
|
You will be notified by the MPS Portal when an order assigned to the Distribution Center or Supplier is forwarded |
|
|
You will be notified by the MPS Portal when the receipt of an order assigned to the Distribution Center or Supplier begins |
|
|
You will be notified by the MPS Portal when the review of an order assigned to the Distribution Center begins |
|
|
You will be notified by the MPS Portal when an order assigned to the Distribution Center or Supplier is completed |
|
|
You will be notified by the MPS Portal when an order assigned to the Distribution Center or Supplier is canceled |
Important
During implementation, it is extremely important to observe the case sensitivity of the method names created in the Web Service.
Field Selection
On the integration configuration screen in the MPS Portal, you can select which fields you want to send to the Web Service. Below is a list of fields and their descriptions.
Note that the fields that will be returned as the default value if none are selected are shown in bold.
-
Property: this is the name used to identify the field within the JSON content that will be sent by the MPS Portal;
-
Description: a brief description of the field.
Order
|
Property |
Description |
|
orderID |
Order ID |
|
orderNumber |
Order Number |
|
orderTypeID |
Order Type (1 = Transfer; 2 = Receipt) |
|
orderCreatedDate |
Order Creation Date |
|
orderField1Value |
Order Customized Value 1 |
|
orderField2Value |
Order Customized Value 2 |
|
orderField3Value |
Order Customized Value 3 |
Applicant
|
Property |
Description |
|
stockRootID |
Requesting Stock ID |
|
stockRootName |
Name of the requesting stock |
|
stockRootType |
Type of the requesting stock |
|
enterpriseName |
Name of the company whose stock supplies the site or warehouse, when the requester is a Distribution Center |
|
stockRootContactName |
Name of the requesting stock contact |
|
stockRootContactEmail |
Email of the requesting stock contact |
|
stockRootContactPhone |
Phone number of the requesting stock contact |
|
stockRootCustomField1Value |
Customized Value 1 for the requesting stock |
|
stockRootCustomField2Value |
Customized field 2 for the requesting stock |
|
stockRootCustomField3Value |
Customized field 3 for the requesting stock |
|
stockRootCountry |
Country where the requesting stock is located |
|
stockRootState |
State where the requesting stock is located |
|
stockRootCity |
City where the requesting stock is located |
|
stockRootStreet |
Street where the requesting stock is located |
|
stockRootNumber |
Number of the requesting stock |
|
stockRootNeighborhood |
Neighborhood where the requesting stock is located |
|
stockRootZIPCode |
ZIP code where the requesting stock is located |
Supplier and Distribution Center
When the order is a Transfer (OrderTypeID = 1), the data below refers to a recipient of the Distribution Center type.
If the order is an Inbound (OrderTypeID = 2), the data below refers to a recipient of the Supplier type.
|
Property |
Description |
|
destID |
Recipient Number |
|
destName |
Recipient Name |
|
destCustomField1Value |
Recipient Customized Value 1 |
|
destCustomField2Value |
Recipient Customized Value 2 |
|
destCustomField3Value |
Recipient Customized Value 3 |
|
destCountry |
Recipient's Country |
|
destState |
State where the recipient is located |
|
destCity |
City where the recipient is located |
|
destStreet |
Street where the recipient is located |
|
destNumber |
Recipient's number |
|
destNeighborhood |
Neighborhood where the recipient is located |
|
destZIPCode |
Zip code where the recipient is located |
Delivery
|
Property |
Description |
|
shipmentID |
Delivery ID |
|
shipmentStatus |
Delivery Status |
|
shipmentCreatedDate |
Delivery Creation Date |
|
expectedDate |
Expected Delivery Date |
|
invoiceNumber |
Delivery Invoice Number |
|
shipmentField1Value |
Delivery Customized Value 1 |
|
shipmentField2Value |
Delivery Customized Value 2 |
|
shipmentField3Value |
Delivery Customized Value 3 |
|
shipmentNumber |
Delivery Number |
Delivery item
|
Property |
Description |
|
shipmentItemID |
Delivery item ID |
|
shipmentItemStatus |
Stock item status |
|
UTCSentDate |
Date the item was sent (UTC 0) |
|
UTCReceivedDate |
Receipt date (UTC 0) |
Supply model
|
Property |
Description |
|
supplyModelID |
ID of the requested supply model |
|
supplyModelBrandName |
Manufacturer of the requested supply model |
|
supplySubFunctionName |
Type of the requested supply model |
|
partNumber |
PartNumber of the requested supply model |
|
capacity |
Capacity of the requested supply model |
|
description |
Description of the requested supply model |
|
quality |
Quality of the requested supply model |
|
internalCode |
Internal code of the requested supply model |
Stock item
|
Property |
Description |
|
stockItemID |
Stock item ID |
|
stockItemSerialNumber |
Stock item serial number |
Impressora
|
Property |
Description |
|
printerName |
Name of the printer to which the requested material is assigned |
|
printerBrandName |
Manufacturer of the printer to which the requested material is assigned |
|
printerModel |
Model of the printer to which the requested material is assigned |
|
addressName |
Address of the printer to which the requested material is assigned |
|
printerSerialNumber |
Serial number of the printer to which the requested material is assigned |
|
siteName |
Site of the printer to which the requested material is assigned |
|
department |
Department of the printer to which the requested material is assigned |
|
location |
Location of the printer to which the requested material is assigned |
|
contractNumber |
Contract for the printer to which the requested material is assigned |
|
assetNumber |
Asset number of the printer to which the requested material is assigned |
|
contactData |
Contact information for the printer to which the requested material is assigned |
|
lastProductionCounterUsed |
Last meter used by the current supply |
|
lastProductionCounterDate |
Date of the last reading of the meter used by the current supply |
|
printersResponsibles |
Person(s) responsible for the printer |
Example of Web Service Implementation
Click here for an example of how to implement the Web Service to receive notifications from the MPS Portal.