OrderManagementService Web Service

OrderManagementService

Click here for a complete list of operations.

GetOrdersBySearchParameters

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 /OrderManagementService.asmx HTTP/1.1
Host: marketplace.oms.webservices.brightstarcorp.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://svcs.marketplace.brightstar.com/GetOrdersBySearchParameters"

<?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>
    <GetOrdersBySearchParameters xmlns="http://svcs.marketplace.brightstar.com/">
      <request>
        <RequestObject>
          <OrderCreationStartDate>dateTime</OrderCreationStartDate>
          <OrderCreationEndDate>dateTime</OrderCreationEndDate>
          <CatalogID>
            <int>int</int>
            <int>int</int>
          </CatalogID>
          <LocationAppID>
            <int>int</int>
            <int>int</int>
          </LocationAppID>
          <LocationID>
            <int>int</int>
            <int>int</int>
          </LocationID>
          <CompanyID>
            <int>int</int>
            <int>int</int>
          </CompanyID>
          <OrgID>int</OrgID>
          <OrderStatus>
            <OrderStatus>Nothing or Confirmed or ERPSalesOrderCreated or Open or Paid or Shipped or Cancelled or ERPPickTicketCreated or PendingConfirmation or PendingCancellation or BackOrder or BackOrderRelease or Delivered or PreOrder or PartiallyShipped</OrderStatus>
            <OrderStatus>Nothing or Confirmed or ERPSalesOrderCreated or Open or Paid or Shipped or Cancelled or ERPPickTicketCreated or PendingConfirmation or PendingCancellation or BackOrder or BackOrderRelease or Delivered or PreOrder or PartiallyShipped</OrderStatus>
          </OrderStatus>
          <LastName>string</LastName>
          <FirstName>string</FirstName>
          <CustomerEmployeeNumber>string</CustomerEmployeeNumber>
          <CustomerPOReference>string</CustomerPOReference>
          <CustomerPOReference1>string</CustomerPOReference1>
          <CustomerPOReference2>string</CustomerPOReference2>
          <CustomerPOReference3>string</CustomerPOReference3>
          <OrderStatusID>
            <int>int</int>
            <int>int</int>
          </OrderStatusID>
        </RequestObject>
      </request>
    </GetOrdersBySearchParameters>
  </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>
    <GetOrdersBySearchParametersResponse xmlns="http://svcs.marketplace.brightstar.com/">
      <GetOrdersBySearchParametersResult>
        <ResponseObjectList>
          <OrderList>
            <MPOrder xsi:nil="true" />
            <MPOrder xsi:nil="true" />
          </OrderList>
        </ResponseObjectList>
      </GetOrdersBySearchParametersResult>
    </GetOrdersBySearchParametersResponse>
  </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 /OrderManagementService.asmx HTTP/1.1
Host: marketplace.oms.webservices.brightstarcorp.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>
    <GetOrdersBySearchParameters xmlns="http://svcs.marketplace.brightstar.com/">
      <request>
        <RequestObject>
          <OrderCreationStartDate>dateTime</OrderCreationStartDate>
          <OrderCreationEndDate>dateTime</OrderCreationEndDate>
          <CatalogID>
            <int>int</int>
            <int>int</int>
          </CatalogID>
          <LocationAppID>
            <int>int</int>
            <int>int</int>
          </LocationAppID>
          <LocationID>
            <int>int</int>
            <int>int</int>
          </LocationID>
          <CompanyID>
            <int>int</int>
            <int>int</int>
          </CompanyID>
          <OrgID>int</OrgID>
          <OrderStatus>
            <OrderStatus>Nothing or Confirmed or ERPSalesOrderCreated or Open or Paid or Shipped or Cancelled or ERPPickTicketCreated or PendingConfirmation or PendingCancellation or BackOrder or BackOrderRelease or Delivered or PreOrder or PartiallyShipped</OrderStatus>
            <OrderStatus>Nothing or Confirmed or ERPSalesOrderCreated or Open or Paid or Shipped or Cancelled or ERPPickTicketCreated or PendingConfirmation or PendingCancellation or BackOrder or BackOrderRelease or Delivered or PreOrder or PartiallyShipped</OrderStatus>
          </OrderStatus>
          <LastName>string</LastName>
          <FirstName>string</FirstName>
          <CustomerEmployeeNumber>string</CustomerEmployeeNumber>
          <CustomerPOReference>string</CustomerPOReference>
          <CustomerPOReference1>string</CustomerPOReference1>
          <CustomerPOReference2>string</CustomerPOReference2>
          <CustomerPOReference3>string</CustomerPOReference3>
          <OrderStatusID>
            <int>int</int>
            <int>int</int>
          </OrderStatusID>
        </RequestObject>
      </request>
    </GetOrdersBySearchParameters>
  </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>
    <GetOrdersBySearchParametersResponse xmlns="http://svcs.marketplace.brightstar.com/">
      <GetOrdersBySearchParametersResult>
        <ResponseObjectList>
          <OrderList>
            <MPOrder xsi:nil="true" />
            <MPOrder xsi:nil="true" />
          </OrderList>
        </ResponseObjectList>
      </GetOrdersBySearchParametersResult>
    </GetOrdersBySearchParametersResponse>
  </soap12:Body>
</soap12:Envelope>