FractusApi Web Service

FractusApi

Click here for a complete list of operations.

ReturnsGetV2

Get a list of returns based on a filter

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /FractusApi.asmx HTTP/1.1
Host: fractusapi-vscm.azurewebsites.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://VisibleSCM.com/ReturnsGetV2"

<?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>
    <ReturnsGetV2 xmlns="http://VisibleSCM.com/">
      <SecurityToken>string</SecurityToken>
      <ClientName>string</ClientName>
      <filter>
        <OrderStatus>string</OrderStatus>
        <Warehouse>string</Warehouse>
        <IncludeChildren>boolean</IncludeChildren>
        <IncludeItem>boolean</IncludeItem>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
      </filter>
    </ReturnsGetV2>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <ReturnsGetV2Response xmlns="http://VisibleSCM.com/">
      <ReturnsGetV2Result>
        <ClientName>string</ClientName>
        <ObjectList>
          <Return>
            <ReturnID>int</ReturnID>
            <CreateDateTime>dateTime</CreateDateTime>
            <ReturnReasonID>int</ReturnReasonID>
            <ProductAmount>decimal</ProductAmount>
            <Name>string</Name>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryID>int</CountryID>
            <Phone>string</Phone>
            <CurrencyID>int</CurrencyID>
            <WarehouseID>int</WarehouseID>
            <OutgoingWarehouseID>int</OutgoingWarehouseID>
            <NewOrderNumber>string</NewOrderNumber>
            <RMAStatusId>int</RMAStatusId>
            <RMANumber>string</RMANumber>
            <CSessionId>int</CSessionId>
            <MSessionId>int</MSessionId>
            <ModifiedDateTime>dateTime</ModifiedDateTime>
            <RowVersion>base64Binary</RowVersion>
            <SourceOrderID>int</SourceOrderID>
            <ReturnFulfillmentItems xsi:nil="true" />
            <ReturnItems xsi:nil="true" />
          </Return>
          <Return>
            <ReturnID>int</ReturnID>
            <CreateDateTime>dateTime</CreateDateTime>
            <ReturnReasonID>int</ReturnReasonID>
            <ProductAmount>decimal</ProductAmount>
            <Name>string</Name>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryID>int</CountryID>
            <Phone>string</Phone>
            <CurrencyID>int</CurrencyID>
            <WarehouseID>int</WarehouseID>
            <OutgoingWarehouseID>int</OutgoingWarehouseID>
            <NewOrderNumber>string</NewOrderNumber>
            <RMAStatusId>int</RMAStatusId>
            <RMANumber>string</RMANumber>
            <CSessionId>int</CSessionId>
            <MSessionId>int</MSessionId>
            <ModifiedDateTime>dateTime</ModifiedDateTime>
            <RowVersion>base64Binary</RowVersion>
            <SourceOrderID>int</SourceOrderID>
            <ReturnFulfillmentItems xsi:nil="true" />
            <ReturnItems xsi:nil="true" />
          </Return>
        </ObjectList>
        <TotalCount>int</TotalCount>
        <CurrentPage>int</CurrentPage>
        <TotalPages>int</TotalPages>
        <PageSize>int</PageSize>
        <ExecutionTime>long</ExecutionTime>
        <ErrorMessage>string</ErrorMessage>
        <ResultCode>string</ResultCode>
      </ReturnsGetV2Result>
    </ReturnsGetV2Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /FractusApi.asmx HTTP/1.1
Host: fractusapi-vscm.azurewebsites.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ReturnsGetV2 xmlns="http://VisibleSCM.com/">
      <SecurityToken>string</SecurityToken>
      <ClientName>string</ClientName>
      <filter>
        <OrderStatus>string</OrderStatus>
        <Warehouse>string</Warehouse>
        <IncludeChildren>boolean</IncludeChildren>
        <IncludeItem>boolean</IncludeItem>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
      </filter>
    </ReturnsGetV2>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ReturnsGetV2Response xmlns="http://VisibleSCM.com/">
      <ReturnsGetV2Result>
        <ClientName>string</ClientName>
        <ObjectList>
          <Return>
            <ReturnID>int</ReturnID>
            <CreateDateTime>dateTime</CreateDateTime>
            <ReturnReasonID>int</ReturnReasonID>
            <ProductAmount>decimal</ProductAmount>
            <Name>string</Name>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryID>int</CountryID>
            <Phone>string</Phone>
            <CurrencyID>int</CurrencyID>
            <WarehouseID>int</WarehouseID>
            <OutgoingWarehouseID>int</OutgoingWarehouseID>
            <NewOrderNumber>string</NewOrderNumber>
            <RMAStatusId>int</RMAStatusId>
            <RMANumber>string</RMANumber>
            <CSessionId>int</CSessionId>
            <MSessionId>int</MSessionId>
            <ModifiedDateTime>dateTime</ModifiedDateTime>
            <RowVersion>base64Binary</RowVersion>
            <SourceOrderID>int</SourceOrderID>
            <ReturnFulfillmentItems xsi:nil="true" />
            <ReturnItems xsi:nil="true" />
          </Return>
          <Return>
            <ReturnID>int</ReturnID>
            <CreateDateTime>dateTime</CreateDateTime>
            <ReturnReasonID>int</ReturnReasonID>
            <ProductAmount>decimal</ProductAmount>
            <Name>string</Name>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryID>int</CountryID>
            <Phone>string</Phone>
            <CurrencyID>int</CurrencyID>
            <WarehouseID>int</WarehouseID>
            <OutgoingWarehouseID>int</OutgoingWarehouseID>
            <NewOrderNumber>string</NewOrderNumber>
            <RMAStatusId>int</RMAStatusId>
            <RMANumber>string</RMANumber>
            <CSessionId>int</CSessionId>
            <MSessionId>int</MSessionId>
            <ModifiedDateTime>dateTime</ModifiedDateTime>
            <RowVersion>base64Binary</RowVersion>
            <SourceOrderID>int</SourceOrderID>
            <ReturnFulfillmentItems xsi:nil="true" />
            <ReturnItems xsi:nil="true" />
          </Return>
        </ObjectList>
        <TotalCount>int</TotalCount>
        <CurrentPage>int</CurrentPage>
        <TotalPages>int</TotalPages>
        <PageSize>int</PageSize>
        <ExecutionTime>long</ExecutionTime>
        <ErrorMessage>string</ErrorMessage>
        <ResultCode>string</ResultCode>
      </ReturnsGetV2Result>
    </ReturnsGetV2Response>
  </soap12:Body>
</soap12:Envelope>