ReportOrderTransportStatusEvent

If you are creating an integration between Ongoing WMS and a shipping platform, you may wish to report certain events to Ongoing WMS, for instance that a transport label has been printed for a particular order. This API call allows you to report those events.

Tags: ReportOrderTransportStatusEvent, ReportOrderTransportStatusEventOperation, ReportOrderTransportStatusEventResponse, ReportOrderTransportStatusEventResult, ReportOrderTransportStatusError

Request XML

POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/ReportOrderTransportStatusEvent"

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ReportOrderTransportStatusEvent xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Operation>
        <OrderId>int</OrderId>
        <Comment>string</Comment>
        <EventTime>dateTime</EventTime>
        <EventType>Delivery or Return</EventType>
        <TransportStatus>Printed or PickedUpByCarrier or OnWay or AtPickUpPlace or Delivered or Cancelled</TransportStatus>
      </Operation>
    </ReportOrderTransportStatusEvent>
  </soap:Body>
</soap:Envelope>

Request specification

ReportOrderTransportStatusEvent
UserName	string(50)	Req.	Your username
Password	string(50)	Req.	Your password
Operation	ReportOrderTransportStatusEventOperation	Req.	The operation object

ReportOrderTransportStatusEventOperation
OrderId	int	Req.	The order ID
Comment	string(400)		Status comment
EventTime	dateTime	Req.	Time when the event took place
EventType	enum	Req.	If this event concerns the return of items back to the warehouse, this value should be Return. Otherwise, it should be Delivery.
TransportStatus	enum	Req.	Status of the event: - Printed - PickedUpByCarrier - OnWay - AtPickUpPlace - Delivered - Cancelled

Response XML

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ReportOrderTransportStatusEventResponse xmlns="http://ongoingsystems.se/Automation">
      <ReportOrderTransportStatusEventResult>
        <Success>boolean</Success>
        <Errors>
          <ReportOrderTransportStatusError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or OrderIdDoesNotExist</ErrorType>
          </ReportOrderTransportStatusError>
          <ReportOrderTransportStatusError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or OrderIdDoesNotExist</ErrorType>
          </ReportOrderTransportStatusError>
        </Errors>
      </ReportOrderTransportStatusEventResult>
    </ReportOrderTransportStatusEventResponse>
  </soap:Body>
</soap:Envelope>

Response specification

ReportOrderTransportStatusEventResponse
ReportOrderTransportStatusEventResult	ReportOrderTransportStatusEventResult

ReportOrderTransportStatusEventResult
Success	boolean	True if successful, false otherwise.
Errors	ReportOrderTransportStatusError[]	A list of ReportOrderTransportStatusError objects

ReportOrderTransportStatusError
Message	string	Message explaining the error.
ErrorType	enum	The type of error: - UnknownError - LogonError - OrderIdDoesNotExist