WarehouseService Web Service

WarehouseService

Click here for a complete list of operations.

SupplierReturnSave

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 /RosecomLive/RoseCommServiceV3/APIV1/WarehouseService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/SupplierReturnSave"

<?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>
    <SupplierReturnSave xmlns="http://tempuri.org/">
      <pSupplierReturnSave>
        <Reference>string</Reference>
        <Date>dateTime</Date>
        <Supplier>
          <SupplierReference>string</SupplierReference>
          <SupplierName>string</SupplierName>
          <POAddress>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <City>string</City>
            <State>string</State>
            <PostCode>string</PostCode>
            <Country xsi:nil="true" />
            <IsDefault>boolean</IsDefault>
            <DateSince>dateTime</DateSince>
            <DurationFromInMonths>int</DurationFromInMonths>
            <PremisesType xsi:nil="true" />
            <IsUsedForCreditCheck>boolean</IsUsedForCreditCheck>
            <AddressSequence>int</AddressSequence>
            <FullAddress>string</FullAddress>
            <HouseName>string</HouseName>
            <ConsigneeName>string</ConsigneeName>
            <AddressCode>string</AddressCode>
            <PhoneNumber>string</PhoneNumber>
            <CustomerID>int</CustomerID>
            <ContactID>int</ContactID>
          </POAddress>
          <IsDefault>boolean</IsDefault>
        </Supplier>
        <Site>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Site>
        <Employee>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Employee>
        <Courier>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Courier>
        <Note>string</Note>
        <CourierTrackingNumber>string</CourierTrackingNumber>
        <TotalValue>decimal</TotalValue>
        <SupplierReturnStatus>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </SupplierReturnStatus>
        <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
        <PostReturnStatus>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </PostReturnStatus>
        <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
        <SupplierCreditNoteTotal>decimal</SupplierCreditNoteTotal>
        <SendMethod>int</SendMethod>
        <AuthorizedBy>string</AuthorizedBy>
        <AuthorizedDate>dateTime</AuthorizedDate>
        <DeliveryCost>decimal</DeliveryCost>
        <bComplete>boolean</bComplete>
        <SupplierReturnDetails>
          <SupplierReturnDetails>
            <Product xsi:nil="true" />
            <SupplierReturnReason xsi:nil="true" />
            <Quantity>int</Quantity>
            <Value>decimal</Value>
            <Note>string</Note>
            <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
            <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
            <SupplierCreditNoteDate>dateTime</SupplierCreditNoteDate>
            <CreditedAmount>decimal</CreditedAmount>
            <SupplierReturnItems xsi:nil="true" />
          </SupplierReturnDetails>
          <SupplierReturnDetails>
            <Product xsi:nil="true" />
            <SupplierReturnReason xsi:nil="true" />
            <Quantity>int</Quantity>
            <Value>decimal</Value>
            <Note>string</Note>
            <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
            <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
            <SupplierCreditNoteDate>dateTime</SupplierCreditNoteDate>
            <CreditedAmount>decimal</CreditedAmount>
            <SupplierReturnItems xsi:nil="true" />
          </SupplierReturnDetails>
        </SupplierReturnDetails>
      </pSupplierReturnSave>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </SupplierReturnSave>
  </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>
    <SupplierReturnSaveResponse xmlns="http://tempuri.org/">
      <SupplierReturnSaveResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <SupplierReturn>
            <Reference>string</Reference>
            <Date>dateTime</Date>
            <Supplier xsi:nil="true" />
            <Site xsi:nil="true" />
            <Employee xsi:nil="true" />
            <Courier xsi:nil="true" />
            <Note>string</Note>
            <CourierTrackingNumber>string</CourierTrackingNumber>
            <TotalValue>decimal</TotalValue>
            <SupplierReturnStatus xsi:nil="true" />
            <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
            <PostReturnStatus xsi:nil="true" />
            <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
            <SupplierCreditNoteTotal>decimal</SupplierCreditNoteTotal>
            <SendMethod>int</SendMethod>
            <AuthorizedBy>string</AuthorizedBy>
            <AuthorizedDate>dateTime</AuthorizedDate>
            <DeliveryCost>decimal</DeliveryCost>
            <bComplete>boolean</bComplete>
            <SupplierReturnDetails xsi:nil="true" />
          </SupplierReturn>
          <SupplierReturn>
            <Reference>string</Reference>
            <Date>dateTime</Date>
            <Supplier xsi:nil="true" />
            <Site xsi:nil="true" />
            <Employee xsi:nil="true" />
            <Courier xsi:nil="true" />
            <Note>string</Note>
            <CourierTrackingNumber>string</CourierTrackingNumber>
            <TotalValue>decimal</TotalValue>
            <SupplierReturnStatus xsi:nil="true" />
            <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
            <PostReturnStatus xsi:nil="true" />
            <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
            <SupplierCreditNoteTotal>decimal</SupplierCreditNoteTotal>
            <SendMethod>int</SendMethod>
            <AuthorizedBy>string</AuthorizedBy>
            <AuthorizedDate>dateTime</AuthorizedDate>
            <DeliveryCost>decimal</DeliveryCost>
            <bComplete>boolean</bComplete>
            <SupplierReturnDetails xsi:nil="true" />
          </SupplierReturn>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </SupplierReturnSaveResult>
    </SupplierReturnSaveResponse>
  </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 /RosecomLive/RoseCommServiceV3/APIV1/WarehouseService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
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>
    <SupplierReturnSave xmlns="http://tempuri.org/">
      <pSupplierReturnSave>
        <Reference>string</Reference>
        <Date>dateTime</Date>
        <Supplier>
          <SupplierReference>string</SupplierReference>
          <SupplierName>string</SupplierName>
          <POAddress>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <City>string</City>
            <State>string</State>
            <PostCode>string</PostCode>
            <Country xsi:nil="true" />
            <IsDefault>boolean</IsDefault>
            <DateSince>dateTime</DateSince>
            <DurationFromInMonths>int</DurationFromInMonths>
            <PremisesType xsi:nil="true" />
            <IsUsedForCreditCheck>boolean</IsUsedForCreditCheck>
            <AddressSequence>int</AddressSequence>
            <FullAddress>string</FullAddress>
            <HouseName>string</HouseName>
            <ConsigneeName>string</ConsigneeName>
            <AddressCode>string</AddressCode>
            <PhoneNumber>string</PhoneNumber>
            <CustomerID>int</CustomerID>
            <ContactID>int</ContactID>
          </POAddress>
          <IsDefault>boolean</IsDefault>
        </Supplier>
        <Site>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Site>
        <Employee>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Employee>
        <Courier>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Courier>
        <Note>string</Note>
        <CourierTrackingNumber>string</CourierTrackingNumber>
        <TotalValue>decimal</TotalValue>
        <SupplierReturnStatus>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </SupplierReturnStatus>
        <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
        <PostReturnStatus>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </PostReturnStatus>
        <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
        <SupplierCreditNoteTotal>decimal</SupplierCreditNoteTotal>
        <SendMethod>int</SendMethod>
        <AuthorizedBy>string</AuthorizedBy>
        <AuthorizedDate>dateTime</AuthorizedDate>
        <DeliveryCost>decimal</DeliveryCost>
        <bComplete>boolean</bComplete>
        <SupplierReturnDetails>
          <SupplierReturnDetails>
            <Product xsi:nil="true" />
            <SupplierReturnReason xsi:nil="true" />
            <Quantity>int</Quantity>
            <Value>decimal</Value>
            <Note>string</Note>
            <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
            <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
            <SupplierCreditNoteDate>dateTime</SupplierCreditNoteDate>
            <CreditedAmount>decimal</CreditedAmount>
            <SupplierReturnItems xsi:nil="true" />
          </SupplierReturnDetails>
          <SupplierReturnDetails>
            <Product xsi:nil="true" />
            <SupplierReturnReason xsi:nil="true" />
            <Quantity>int</Quantity>
            <Value>decimal</Value>
            <Note>string</Note>
            <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
            <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
            <SupplierCreditNoteDate>dateTime</SupplierCreditNoteDate>
            <CreditedAmount>decimal</CreditedAmount>
            <SupplierReturnItems xsi:nil="true" />
          </SupplierReturnDetails>
        </SupplierReturnDetails>
      </pSupplierReturnSave>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </SupplierReturnSave>
  </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>
    <SupplierReturnSaveResponse xmlns="http://tempuri.org/">
      <SupplierReturnSaveResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <SupplierReturn>
            <Reference>string</Reference>
            <Date>dateTime</Date>
            <Supplier xsi:nil="true" />
            <Site xsi:nil="true" />
            <Employee xsi:nil="true" />
            <Courier xsi:nil="true" />
            <Note>string</Note>
            <CourierTrackingNumber>string</CourierTrackingNumber>
            <TotalValue>decimal</TotalValue>
            <SupplierReturnStatus xsi:nil="true" />
            <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
            <PostReturnStatus xsi:nil="true" />
            <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
            <SupplierCreditNoteTotal>decimal</SupplierCreditNoteTotal>
            <SendMethod>int</SendMethod>
            <AuthorizedBy>string</AuthorizedBy>
            <AuthorizedDate>dateTime</AuthorizedDate>
            <DeliveryCost>decimal</DeliveryCost>
            <bComplete>boolean</bComplete>
            <SupplierReturnDetails xsi:nil="true" />
          </SupplierReturn>
          <SupplierReturn>
            <Reference>string</Reference>
            <Date>dateTime</Date>
            <Supplier xsi:nil="true" />
            <Site xsi:nil="true" />
            <Employee xsi:nil="true" />
            <Courier xsi:nil="true" />
            <Note>string</Note>
            <CourierTrackingNumber>string</CourierTrackingNumber>
            <TotalValue>decimal</TotalValue>
            <SupplierReturnStatus xsi:nil="true" />
            <SupplierAuthorisationReference>string</SupplierAuthorisationReference>
            <PostReturnStatus xsi:nil="true" />
            <SupplierCreditNoteReference>string</SupplierCreditNoteReference>
            <SupplierCreditNoteTotal>decimal</SupplierCreditNoteTotal>
            <SendMethod>int</SendMethod>
            <AuthorizedBy>string</AuthorizedBy>
            <AuthorizedDate>dateTime</AuthorizedDate>
            <DeliveryCost>decimal</DeliveryCost>
            <bComplete>boolean</bComplete>
            <SupplierReturnDetails xsi:nil="true" />
          </SupplierReturn>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </SupplierReturnSaveResult>
    </SupplierReturnSaveResponse>
  </soap12:Body>
</soap12:Envelope>