General Discussion:
If a Distributor is sending a request with invalid parameters, Suppliers should send a response with the specific error response in the below format. See example details below.
Example 1: User sending invalid credentials in the request.
Supplier Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.promostandards.org/WSDL/OrderStatusService/1.0.0/">
<SOAP-ENV:Body>
<ns1:GetOrderStatusDetailsResponse>
<ns1:errorMessage>105: Authentication Credentials failed</ns1:errorMessage>
</ns1:GetOrderStatusDetailsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example 2: User sending incorrect Reference Number in the request. (Query Type 1 or 2)
Supplier Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.promostandards.org/WSDL/OrderStatusService/1.0.0/">
<SOAP-ENV:Body>
<ns1:GetOrderStatusDetailsResponse>
<ns1:errorMessage>301: referenceNumber not found</ns1:errorMessage>
</ns1:GetOrderStatusDetailsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
GetOrderStatusDetailsResponse
Field | Description | Required | Best Practice |
OrderStatusArray | An array of order status | TRUE | TRUE |
errorMessage | Response for any error requiring notification to requestor | FALSE | TRUE - Suppliers should provide as verbose as possible error messages in responses to minimize need for support to clarify. |
OrderStatusArray
Field | Description | Required | Best Practice |
purchaseOrderNumber | The associated Purchase Order Number from the customer | TRUE | TRUE |
OrderStatusDetailArray | Array of OrderStatusDetails | TRUE | TRUE |
Order Status Detail Array
Field | Description | Required | Best Practice |
factoryOrderNumber | The associated factory sales order number (This is used in the example of internal PO splitting at the factory level) | TRUE | TRUE |
statusID | Paired standard order status from allowed values | TRUE | TRUE |
statusName | Textual description of statusID | TRUE | TRUE |
expectedShipDate | The expected ship date for the purchase order | FALSE | |
expectedDeliveryDate | The expected date the order should arrive at customer also known as the “in hands date” | FALSE | |
ResponseToArray | An array of human contact information such as email, phone, and rep name so the distributor knows who to get in contact to fix an issue. | FALSE | |
additionalExplanation | This allows further detail about the status | FALSE | |
responseRequired | True or False to determine if it is necessary to provide information back to the supplier to complete the order | TRUE | TRUE |
validTimestamp | Time of order status | TRUE | TRUE |