View source for 42Q-MES0170-A 42Q Xchange ERP APIs


<small>[[42Q_Cloud-Based_MES/MOMS|42Q Home]] > [[Tools|Tools]] > [[42Q_Xchange_ERP_APIs|42Q Xchange ERP APIs]] > 42Q Xchange ERP APIs</small>

&nbsp;

&nbsp;

&nbsp;
<center>'''Tools'''</center> <center>'''42Q Xchange ERP APIs<br/> Version MES15.79<br/> Revision C1'''</center> <center>&nbsp;</center> <center>&nbsp;</center> <center>&nbsp;</center> 
= <span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introduction"><span class="mw-headline" id="Introdcution"><span class="mw-headline" id="Introdcution"><span class="mw-headline" id="Introdcution"><span class="mw-headline" id="Introdcution"><span class="mw-headline" id="Introdcution"><span class="mw-headline" id="Introdcution"><span class="mw-headline" id="Introdcution"><span class="mw-headline" id="Introdcution"><span class="mw-headline" id="Introdcution">Introduction</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span> =

The '''42Q Xchange ERP APIs''' is a middleware pub/sub (publish-subscribe) solution that can be installed into the customer’s ERP system to seamlessly integrate with 42Q, ERP adapters, such as SAP, Oracle, and NetSuite. These adapters send and synchronize ERP work orders to 42Q, while 42Q passes back and automatically updates the ERP system with operation, resource, material, and serial / lot information. Shipment information is also passed to 42Q to close the loop for serial and sales order information within 42Q.<br/> This ERP adapter is also capable of integrating the customer's Excel VBA Client, Customer Built Client, or Custom Built 42Q Adapters systems with 42Q and ERP.<br/> The main advantages of integrating the 42Q Xchange ERP APIs are:

*No need for duplication of effort in a customer's ERP system and 42Q. 
*Improving efficiency 
*Improving accuracy 
*Linking these systems together. 

<u>'''Note:'''</u> Communication between 42Q and ERP systems is through work order management.<br/> 42Q Xchange ERP APIs offers:<br/> &nbsp;

#'''Work Order Creation:''' Sending work orders from ERP to 42Q. Work order creation sends work order header, routing, components, and custom attributes from ERP to 42Q. This also includes sending ATO type of work orders from ERP to 42Q. Work Orders are created based on unique requirements 
#'''Work Order Update:''' Sending work order changes from ERP to 42Q. Changes can be on: '''Dates''', '''Status''', '''Quantities Increases''', '''Route''' (Department/Operations), '''Components''' (Add/Remove/Supply type). 
#'''WIP Moves/Material Issues:''' Sending Incremental Unit movements, Rework, Scrap, and Completion movement from 42Q to ERP. WIP Moves updates ERP with the latest progress of the product. Material Issue sends the material/component consumption transaction from 42Q to ERP, it includes the material consumed, serial/lot number, and quantity consumed. 
#'''Ship Notification:''' Sending shipment information and serial information to 42Q after sales order shipment on ERP. 

The below diagram illustrates how the 42Q Xchange ERP APIs work:

&nbsp;

'''Figure 1: 42Q Xchange ERP APIs Integration'''

[[File:42QXEA 42Q Xchange ERP APIs Integration.png|900px]]

&nbsp;

42Q also contains a complimentary REST like API for customers with ERP systems not currently supported by the 42Q ERP Adapters; these 42Q Xchange APIs provide the same integration functionality as the 42Q ERP Adapters. Work Order and Shipment information can be sent directly to the 42Q Xchange API and WIP information from 42Q can be pulled from the 42Q Xchange API in a pub/sub type model.

Customers are able to create their own '''Clients''' and '''Adapters'''. In Figure 2, users can see a diagram of the recommended Customer Built Client Architecture.

&nbsp;

<br/> '''Figure 2: Customer Built Client Architecture Diagram'''<br/> [[File:42QXEA Customer Built Client Architecture Diagram.png|900px]]

&nbsp;

= <span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions"><span class="mw-headline" id="Supported_Transactions">Supported Transactions</span></span></span></span></span></span></span></span></span></span></span></span></span></span> =

'''Figure 3: Supported Transactions Diagram'''

[[File:42QXEA Supported Transactions Diagram.png|900px|42QXEA Supported Transactions Diagram.png]]

&nbsp;

= <span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details"><span class="mw-headline" id="42Q_Xchange_API_Details">42Q Xchange API Details</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span> =

'''API Details:'''<br/> Protocol: HTTPS<br/> Encryption: Recommended TLS 1.3. Does support TLS 1.0 or greater.<br/> Security: Basic Authorization<br/> Content Type: application/json<br/> HTTP Method: POST

<br/> '''API Base URL:'''<br/> Prod: [https://erpwaf.42-q.com https://erpwaf.42-q.com]<br/> UAT: [https://erpuatwaf.42-q.com https://erpuatwaf.42-q.com]

<br/> '''API Paths:'''<br/> /erp/wo/create: Post a new Work Order to 42Q.<br/> /erp/wo/update: Update an existing Work Order in 42Q.<br/> /erp/wo/status: Retrieve the 42Q processing status of a Work Order /create or /update message sent.<br/> /erp/wo/liveupdate: Live update of Work Order in 42Q.<br/> /erp/order/shipment: Post Sales Order Shipment and Serial Information to 42Q.<br/> /erp/wo/wip: Retrieve Work Order Operation Completions, Material Issues and Unit Completions from 42Q that are not marked as previously pulled.<br/> /erp/wo/wip/period: Retrieve Work Order Operation Completions, Material Issues and Unit Completions from 42Q for a period of duration.<br/> /erp/wo/notify: Retrieve ERP Notifications from 42Q that are not marked as previously pulled.<br/> /erp/wo/notify/period: Retrieve ERP Notifications from 42Q for a period of duration.<br/> &nbsp;

A 42Q Xchange API Schema Definition is provided, this document details the data to be provided in the request payloads and expected responses.&nbsp;

A 42Q Xchange API Swagger Definition is provided, this can be viewed in a swagger tool, such as '''[https://editor.swagger.io https://editor.swagger.io]''', to get a more graphical/detailed description of the API.

&nbsp;

= <span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice"><span class="mw-headline" id="Overview_of_42Q_Xchange_Using_Excel.2FLibreOffice">Overview of 42Q Xchange Using Excel/LibreOffice</span></span></span></span></span></span></span></span></span></span></span></span></span> =

== <span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice"><span class="mw-headline" id="Create_a_42Q_Production_Order_from_Excel.2FLibreOffice">Create a 42Q Production Order from Excel/LibreOffice</span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span> ==

&nbsp;

<span class="mw-headline"><span class="mw-headline">In order to create a 42Q Production Order using a type of client, for example, '''Excel VBA''', users must follow the next steps:</span></span>

<span class="mw-headline"><span class="mw-headline"><u>'''Note:'''</u> The Excel/LibreOffice file will be provided by the 42Q team.</span></span>

#<span class="mw-headline"><span class="mw-headline">Open the Excel file that contains the 42Q Production Order Creation Form.</span></span> 
#<span class="mw-headline"><span class="mw-headline">Enter all the required (*) information described in the form. Currently, form supports:</span></span> 
<ol start="1" style="list-style-type: lower-alpha;">
<br/> <li><span class="mw-headline">Shop Order Header details (job number, part number, part description, quantity, etc).</span></li>
</ol>

'''<span class="mw-headline"><span class="mw-headline">Figure 4: Shop Order Header Details Table</span></span>'''<br/> [[File:42QXEA Shop Order Header Details Table.png|42QXEA Shop Order Header Details Table.png]]

&nbsp;
<ol start="2" style="list-style-type: lower-alpha;">
<br/> <li><span class="mw-headline"><span class="mw-headline">Custom attributes at Work Order Level and Work Order Part Level.</span></span></li>
</ol>

'''<span class="mw-headline"><span class="mw-headline">Figure 5: Custom Attributes Table</span></span>'''

'''<span class="mw-headline"><span class="mw-headline">[[File:42QXEA Custom Attributes Table.png|42QXEA Custom Attributes Table.png]]</span></span>'''

&nbsp;
<ol start="3" style="list-style-type: lower-alpha;">
<br/> <li><span class="mw-headline"><span class="mw-headline">Component Details.</span></span></li>
</ol>

'''Figure 6: Component Details Table'''

[[File:42QXEA Component Details Table.png|900px|42QXEA Component Details Table.png]]

&nbsp;
<ol start="4" style="list-style-type: lower-alpha;">
<br/> <li><span class="mw-headline"><span class="mw-headline">Routing Details.</span></span></li>
</ol>

'''Figure 7: Routing Details Table'''

'''[[File:42QXEA Routing Details Table.png|900px|42QXEA Routing Details Table.png]]'''

<u>'''Note:'''</u> The Libre Calc. file only supports Header information for WO Create.

&nbsp;
<ol start="3">
<br/> <li>Click the '''Send To 42Q''' button.</li>
</ol>

<u>'''Note:'''</u> The value for the field '''MESSAGE: ID''' can be whatever value the users want, and it is not necessary to be a unique value.

&nbsp;

'''Figure 8: 42Q Production Order Creation Form'''

'''[[File:42QXEA 42Q Production Order Creation Form.png|42QXEA 42Q Production Order Creation Form.png]]'''

&nbsp;
<ol start="4">
<br/> <li>A new pop-up window will display, users must enter their password to submit the order.</li>
<li>Click the '''OK''' button.</li>
<li>A pop-up window will display to confirm to users that the work order creation request has been accepted, click the '''OK''' button to close it. The API call status will also show '''Success’ status'''.</li>
</ol>

&nbsp;

'''Figure 9: Enter User’s Password'''

'''[[File:42QXEA Enter User’s Password.png|42QXEA Enter User’s Password.png]]'''

&nbsp;

&nbsp;

'''Figure 10: Response Window'''

'''[[File:42QXEA Response Window.png|42QXEA Response Window.png]]'''

&nbsp;

'''Figure 11: API Response Message Recorded'''

'''[[File:42QXEA API Response Message Recorded.png|42QXEA API Response Message Recorded.png]]'''

&nbsp;

<u>'''Note:'''</u> Users can only create one production work order at a time, and it's not possible to create a production work order with the same job number.

&nbsp;

&nbsp;

== <span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement"><span class="mw-headline" id="Check_Production_Order_Acknowledgement">Check Production Order Acknowledgement</span></span></span></span></span></span></span></span></span></span></span> ==

When a work order is sent to 42Q, 42Q will send an acknowledgment transaction back. Users can check the acknowledgment message on Excel and LibreOffice macro files using the following steps:

#Open the Excel file with '''Get 42Q Production Order Create Ack'''. 
#Provide the Job number with the correct message Id, org code, and customer code, then, select '''Get WO Ack status'''. 
#A pop-up response message will display, containing the status and message of the work order acknowledgment. 
#WO Creation status, API call status, and Ref message will be updated. 

&nbsp;

'''Figure 12: Get 42Q Production Order Create Ack'''

[[File:42QXEA Get 42Q Production Order Create Ack.png|900px|42QXEA Get 42Q Production Order Create Ack.png]]

&nbsp;

'''Figure 13: Response'''

'''[[File:42QXEA Response.png|42QXEA Response.png]]'''

&nbsp;

&nbsp;

= <span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples"><span class="mw-headline" id="42Q_Xchange_ERP_API_Samples">42Q Xchange ERP API Samples</span></span></span></span></span></span></span></span></span></span></span></span> =

[https://erpuatwaf.42-q.com/erp/wo/create https://erpuatwaf.42-q.com/erp/wo/create]<br/> Request:<br/> {<br/> &nbsp; &nbsp; "MESSAGE_ID": "123e4567-e89b-12d3-a456-426614174000",<br/> &nbsp; &nbsp; "ORGANIZATION_CODE": "ORG1",<br/> &nbsp; &nbsp; "CUSTOMER_CODE": "GENERIC",<br/> &nbsp; &nbsp; "JOB_NUMBER": "JL9f",<br/> &nbsp; &nbsp; "PART_DESCRIPTION": "42Q-MUG FINISHED GOOD",<br/> &nbsp; &nbsp; "ASSEMBLY_ITEM_NUMBER": "42Q-MUG",<br/> &nbsp; &nbsp; "QUANTITY": 6,<br/> &nbsp; &nbsp; "JOB_STATUS": "RELEASED"<br/> }<br/> Response:<br/> {<br/> &nbsp; &nbsp; "STATUS": "Success",<br/> &nbsp; &nbsp; "MESSAGE": "WO Create Request Accepted.",<br/> &nbsp; &nbsp; "WO": [],<br/> &nbsp; &nbsp; "WIP": [],<br/> &nbsp; &nbsp; "REF": {<br/> &nbsp; &nbsp; &nbsp; &nbsp; "CUST": "123e4567-e89b-12d3-a456-426614174000",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "42Q": 58,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "API": "bd7ae623-3850-4985-ab1b-11e20cdecbc9",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_CDE": 0,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_MSG": "",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "DATETIME": "2021-03-09T16:48:02.720Z"<br/> &nbsp; &nbsp; }<br/> }

[https://erpuatwaf.42-q.com/erp/wo/status https://erpuatwaf.42-q.com/erp/wo/status]<br/> Request:<br/> {<br/> &nbsp; &nbsp; "MESSAGE_ID": "123e4567-e89b-12d3-a456-426614174000",<br/> &nbsp; &nbsp; "ORGANIZATION_CODE": "ORG1",<br/> &nbsp; &nbsp; "CUSTOMER_CODE": "GENERIC",<br/> &nbsp; &nbsp; "JOB_NUMBER": "JL9f"<br/> }<br/> Response:<br/> {<br/> &nbsp; &nbsp; "STATUS": "Success",<br/> &nbsp; &nbsp; "MESSAGE": "7 - Received by 42Q",<br/> &nbsp; &nbsp; "WO": [],<br/> &nbsp; &nbsp; "WIP": [],<br/> &nbsp; &nbsp; "REF": {<br/> &nbsp; &nbsp; &nbsp; &nbsp; "CUST": "123e4567-e89b-12d3-a456-426614174000",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "42Q": -1,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "API": "8bbe3828-273c-484e-a157-059afbc11199",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_CDE": 0,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_MSG": "",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "DATETIME": "2021-03-09T16:48:29.186Z"<br/> &nbsp; &nbsp; }<br/> }<br/> [https://erpuatwaf.42-q.com/erp/wo/update https://erpuatwaf.42-q.com/erp/wo/update]<br/> Request:<br/> {<br/> &nbsp; &nbsp; "MESSAGE_ID": "123e4567-e89b-12d3-a456-426614174000",<br/> &nbsp; &nbsp; "ORGANIZATION_CODE": "ORG1",<br/> &nbsp; &nbsp; "CUSTOMER_CODE": "GENERIC",<br/> &nbsp; &nbsp; "JOB_NUMBER": "JL9f",<br/> &nbsp; &nbsp; "PART_DESCRIPTION": "42Q-MUG FINISHED GOOD",<br/> &nbsp; &nbsp; "ASSEMBLY_ITEM_NUMBER": "42Q-MUG",<br/> &nbsp; &nbsp; "QUANTITY": 6,<br/> &nbsp; &nbsp; "JOB_STATUS": "RELEASED"<br/> }<br/> Response:<br/> {<br/> &nbsp; &nbsp; "STATUS": "Success",<br/> &nbsp; &nbsp; "MESSAGE": "WO Update Request Accepted.",<br/> &nbsp; &nbsp; "WO": [],<br/> &nbsp; &nbsp; "WIP": [],<br/> &nbsp; &nbsp; "REF": {<br/> &nbsp; &nbsp; &nbsp; &nbsp; "CUST": "123e4567-e89b-12d3-a456-426614174000",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "42Q": 58,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "API": "bd7ae623-3850-4985-ab1b-11e20cdecbc9",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_CDE": 0,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_MSG": "",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "DATETIME": "2021-03-09T16:48:02.720Z"<br/> &nbsp; &nbsp; }<br/> }

[https://erpuatwaf.42-q.com/erp/wo/liveupdate https://erpuatwaf.42-q.com/erp/wo/liveupdate]<br/> Request:<br/> {<br/> &nbsp; &nbsp; "MESSAGE_ID": "43D03251548A5238E05366FAA4943E45",<br/> &nbsp; &nbsp; "ORGANIZATION_CODE": "ORG1",<br/> &nbsp; &nbsp; "CUSTOMER_CODE": "GENERIC",<br/> &nbsp; &nbsp; "JOB_NUMBER": "JL9f",<br/> &nbsp; &nbsp; "QUANTITY": 5,<br/> &nbsp; &nbsp; "JOB_STATUS": "7"<br/> }<br/> Response:<br/> {<br/> &nbsp; &nbsp; "STATUS": "Error",<br/> &nbsp; &nbsp; "MESSAGE": "false Job not released in MDS",<br/> &nbsp; &nbsp; "WO": [],<br/> &nbsp; &nbsp; "WIP": [],<br/> &nbsp; &nbsp; "REF": {<br/> &nbsp; &nbsp; &nbsp; &nbsp; "CUST": "43D03251548A5238E05366FAA4943E45",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "42Q": 60,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "API": "900b72f8-b923-4a9d-98c0-599a95932f35",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_CDE": 1,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_MSG": "Job cannot be changed",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "DATETIME": "2021-03-09T16:52:37.489Z"<br/> &nbsp; &nbsp; }<br/> }<br/> [https://erpuatwaf.42-q.com/erp/order/shipment https://erpuatwaf.42-q.com/erp/order/shipment]<br/> Request:<br/> {<br/> &nbsp; &nbsp; "MESSAGE_ID": "43D03251548A5238E05366FAA4943E45",<br/> &nbsp; &nbsp; "ORGANIZATION_CODE": "ORG1",<br/> &nbsp; &nbsp; "CUSTOMER_CODE": "GENERIC",<br/> &nbsp; &nbsp; "SALES_ORDER": "SO0001",<br/> &nbsp; &nbsp; "CUST_PO_NUMBER": "PO0001",<br/> &nbsp; &nbsp; "SHIP_IDENTIFIER": "AIR0001-42Q",<br/> &nbsp; &nbsp; "SHIP_METHOD": "AIR",<br/> &nbsp; &nbsp; "SHIP_TO_LOCATION": "42Q",<br/> &nbsp; &nbsp; "SHIP_TO_ADDRESS1": "Plumeria Drive",<br/> &nbsp; &nbsp; "SHIP_TO_ADDRESS2": "Building 2",<br/> &nbsp; &nbsp; "SHIP_TO_CITY": "SAN JOSE",<br/> &nbsp; &nbsp; "SHIP_TO_STATE": "CA",<br/> &nbsp; &nbsp; "SHIP_TO_COUNTRY": "US",<br/> &nbsp; &nbsp; "SERIALS": [<br/> &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SERIAL": "SABC00001",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LINE_NUMBER": "x1"<br/> &nbsp; &nbsp; &nbsp; &nbsp; },<br/> &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SERIAL": "SABC00002",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LINE_NUMBER": "x2"<br/> &nbsp; &nbsp; &nbsp; &nbsp; }<br/> &nbsp; &nbsp; ]<br/> }<br/> Response:<br/> {<br/> &nbsp; &nbsp; "STATUS": "Success",<br/> &nbsp; &nbsp; "MESSAGE": "Ship Notify Sent Successfully.",<br/> &nbsp; &nbsp; "WO": [],<br/> &nbsp; &nbsp; "WIP": [],<br/> &nbsp; &nbsp; "REF": {<br/> &nbsp; &nbsp; &nbsp; &nbsp; "CUST": "43D03251548A5238E05366FAA4943E45",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "42Q": 59,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "API": "1a9a582a-e057-4c45-8b12-a55fd42ed3a9",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_CDE": 0,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_MSG": "",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "DATETIME": "2021-03-09T16:49:13.085Z"<br/> &nbsp; &nbsp; }<br/> }

<br/> [https://erpuatwaf.42-q.com/erp/wo/wip https://erpuatwaf.42-q.com/erp/wo/wip]<br/> Request:<br/> {<br/> &nbsp; &nbsp; "MESSAGE_ID": "43D03251548A5238E05366FAA4943E45",<br/> &nbsp; &nbsp; "ORGANIZATION_CODE": "ORG1",<br/> &nbsp; &nbsp; "CUSTOMER_CODE": "GENERIC"<br/> }<br/> [https://erpuatwaf.42-q.com/erp/wo/wip/period https://erpuatwaf.42-q.com/erp/wo/wip/period]<br/> Request:<br/> {<br/> &nbsp; &nbsp; "MESSAGE_ID": "43D03251548A5238E05366FAA4943E45",<br/> &nbsp; &nbsp; "ORGANIZATION_CODE": "ORG1",<br/> &nbsp; &nbsp; "CUSTOMER_CODE": "GENERIC",<br/> &nbsp; &nbsp; "START_DATETIME": "2021-04-22",<br/> &nbsp; &nbsp; "END_DATETIME": "2021-04-23T10:23:22.22Z"<br/> }<br/> Response:<br/> {<br/> &nbsp; &nbsp; "STATUS": "Success",<br/> &nbsp; &nbsp; "MESSAGE": "",<br/> &nbsp; &nbsp; "WO": [],<br/> &nbsp; &nbsp; "WIP": [<br/> &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "JOB_NUMBER": "JL1",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "TRANSACTION_ID": 13145,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "MESSAGE_ID": "c4246601-00c8-4134-a90e-057973e39452",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "DATE_TIME": "2020-10-30T15:20:02.886",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "MOVES": [<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "QUANTITY": 1,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "FROM_SEQUENCE": 30,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "FROM_STEP": "In Queue",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "TO_SEQUENCE": 40,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "TO_STEP": "In Queue",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SEQUENCE": 3,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "HANDS_ON_TIME": 4,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "PICKED": false<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; },<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "QUANTITY": 2,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "FROM_SEQUENCE": 40,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "FROM_STEP": "In Queue",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "TO_SEQUENCE": 50,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "TO_STEP": "In Queue",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SEQUENCE": 5,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "HANDS_ON_TIME": 6,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "PICKED": false<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ],<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "COMPLETIONS": [<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SERIAL_NUMBER": "2090308-001",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "MANUFACTURE_DATE": "2020-10-30T10:17:02.000-04:00",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "PICKED": false<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; },<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SERIAL_NUMBER": "2090308-002",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "MANUFACTURE_DATE": "2020-09-30T11:17:02.000-04:00",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "PICKED": false<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ],<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "MTRL_MOVE": [<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "COMPONENT_ITEM": "42Q-SHEET1",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "OP_SEQUENCE": 0,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SUB_INVENTORY": "test",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SUB_LOCATOR": "test",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "QUANTITY": 1,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "TYPE": "ISSUE",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "PICKED": false,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "DETAILS": [<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LOT_NUMBER": null,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LOT_QUANTITY": null,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SERIAL_NUMBER": "INST900078",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "PARENT_SERIAL": "MUG000138"<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; },<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LOT_NUMBER": null,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LOT_QUANTITY": null,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SERIAL_NUMBER": "INST900078",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "PARENT_SERIAL": "MUG000138"<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ]<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; },<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "COMPONENT_ITEM": "42Q-INST",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "OP_SEQUENCE": 10,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SUB_INVENTORY": "test",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SUB_LOCATOR": "test",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "QUANTITY": 1,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "TYPE": "ISSUE",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "PICKED": false,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "DETAILS": [<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LOT_NUMBER": "1000",<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "LOT_QUANTITY": 1,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "SERIAL_NUMBER": null,<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "PARENT_SERIAL": null<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ]<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }<br/> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ]<br/> &nbsp; &nbsp; &nbsp; &nbsp; }<br/> &nbsp; &nbsp; ],<br/> &nbsp; &nbsp; "REF": {<br/> &nbsp; &nbsp; &nbsp; &nbsp; "CUST": "43D03251548A5238E05366FAA4943E45",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "42Q": -1,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "API": "f92a8889-3deb-42e5-b5c6-1e715163d80d",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_CDE": 0,<br/> &nbsp; &nbsp; &nbsp; &nbsp; "ERR_MSG": "",<br/> &nbsp; &nbsp; &nbsp; &nbsp; "DATETIME": "2021-03-24T07:11:59.614-07:00"<br/> &nbsp; &nbsp; }<br/> }

&nbsp;

&nbsp;

= <span class="mw-headline" id="42Q_Xchange_API_Schema_Definition"><span class="mw-headline" id="42Q_Xchange_API_Schema_Definition">42Q Xchange API Schema Definition</span></span> =

The tables below represent the different types of schemas included in the 42Q Xchange API. Each table provides information about every single field/element name, data type, whether it is required or not, description, and one example.

&nbsp;

'''Figure 14: Summary Schema'''<br/> [[File:42QXEA Summary Schema.png|900px]]

&nbsp;

'''Figure 15: WOFullSchema'''

[[File:42QXEA WOFullSchema.png|900px]]

&nbsp;

'''Figure 16: WOStatusSchema'''

[[File:42QXEA WOStatusSchema.png|900px]]

&nbsp;

'''Figure 17: WIPSchema-NotifySchema'''

[[File:42QXEA WIPSchema-NotifySchema.png|900px]]

&nbsp;

'''Figure 18: WIPPeriodSchema-NotifyPeriodSchema'''

[[File:42QXEA WIPPeriodSchema-NotifyPeriodSchema.png|900px]]

&nbsp;

'''Figure 19: WOLiveUpateSchema'''

[[File:42QXEA WOLiveUpateSchema.png|900px]]

&nbsp;

'''Figure 20: ShipmentSchema'''

[[File:42QXEA ShipmentSchema.png|900px]]

&nbsp;

'''Figure 21: OutSchema'''

[[File:42QXEA OutSchema.png|900px]]

&nbsp;

'''Figure 22: WIPOutSchema'''

[[File:42QXEA WIPOutSchema.png]]

&nbsp;

'''Figure 23: NotifyOutSchema'''

[[File:42QXEA NotifyOutSchema.png]]

&nbsp;