CatalogManagementService Web Service

CatalogManagementService

Click here for a complete list of operations.

GetPartInfoByPartNumber

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

<?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>
    <GetPartInfoByPartNumber xmlns="http://svcs.marketplace.brightstar.com/">
      <request>
        <RequestObject>
          <CatalogPartMasterID>int</CatalogPartMasterID>
          <WarehouseID>int</WarehouseID>
          <CatalogID>int</CatalogID>
          <CarrierID>int</CarrierID>
          <CarrierName>string</CarrierName>
          <PartTypeID>int</PartTypeID>
          <PartNumber>string</PartNumber>
          <PartDescription>string</PartDescription>
          <UPCCode>string</UPCCode>
          <WebDescription>string</WebDescription>
          <VendorPartNumber>string</VendorPartNumber>
          <CustomerPartNumber>string</CustomerPartNumber>
          <CustomerEntityID>int</CustomerEntityID>
          <Model>string</Model>
          <AccessoryPartNumber>string</AccessoryPartNumber>
          <VendorAccessoryPartNumber>string</VendorAccessoryPartNumber>
          <Active>boolean</Active>
          <Available>boolean</Available>
          <QuantityReserved>int</QuantityReserved>
          <QuantityUnreserved>int</QuantityUnreserved>
          <QuantityStandard>int</QuantityStandard>
          <QuantityPreOrder>int</QuantityPreOrder>
          <IsReservable>boolean</IsReservable>
          <IsSimRequired>boolean</IsSimRequired>
          <IsAssociated>boolean</IsAssociated>
          <Plans>
            <MPPlan xsi:nil="true" />
            <MPPlan xsi:nil="true" />
          </Plans>
          <ImageList>
            <MPImage xsi:nil="true" />
            <MPImage xsi:nil="true" />
          </ImageList>
          <FeatureList>
            <MPFeature xsi:nil="true" />
            <MPFeature xsi:nil="true" />
          </FeatureList>
          <ScheduleActive>boolean</ScheduleActive>
          <ScheduleActiveDate>dateTime</ScheduleActiveDate>
          <PriceUnit>decimal</PriceUnit>
          <CurrencyCode>string</CurrencyCode>
          <IsReserved>boolean</IsReserved>
          <CustomerPriceUnit>decimal</CustomerPriceUnit>
          <Condition>string</Condition>
          <ConditionNotes>string</ConditionNotes>
          <MPN>string</MPN>
          <Title>string</Title>
          <RetailPrice>decimal</RetailPrice>
          <Color>string</Color>
          <Type>string</Type>
          <Manufacturer>string</Manufacturer>
          <PartClass>string</PartClass>
          <PartGroup>string</PartGroup>
          <PartCategory>string</PartCategory>
          <PartSubCategory>string</PartSubCategory>
          <Weight>decimal</Weight>
          <MemorySize>string</MemorySize>
          <LongDescription>string</LongDescription>
          <DateModified>dateTime</DateModified>
          <Locked>string</Locked>
        </RequestObject>
      </request>
    </GetPartInfoByPartNumber>
  </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>
    <GetPartInfoByPartNumberResponse xmlns="http://svcs.marketplace.brightstar.com/">
      <GetPartInfoByPartNumberResult>
        <ResponseObject>
          <CatalogPartMasterID>int</CatalogPartMasterID>
          <WarehouseID>int</WarehouseID>
          <CatalogID>int</CatalogID>
          <CarrierID>int</CarrierID>
          <CarrierName>string</CarrierName>
          <PartTypeID>int</PartTypeID>
          <PartNumber>string</PartNumber>
          <PartDescription>string</PartDescription>
          <UPCCode>string</UPCCode>
          <WebDescription>string</WebDescription>
          <VendorPartNumber>string</VendorPartNumber>
          <CustomerPartNumber>string</CustomerPartNumber>
          <CustomerEntityID>int</CustomerEntityID>
          <Model>string</Model>
          <AccessoryPartNumber>string</AccessoryPartNumber>
          <VendorAccessoryPartNumber>string</VendorAccessoryPartNumber>
          <Active>boolean</Active>
          <Available>boolean</Available>
          <QuantityReserved>int</QuantityReserved>
          <QuantityUnreserved>int</QuantityUnreserved>
          <QuantityStandard>int</QuantityStandard>
          <QuantityPreOrder>int</QuantityPreOrder>
          <IsReservable>boolean</IsReservable>
          <IsSimRequired>boolean</IsSimRequired>
          <IsAssociated>boolean</IsAssociated>
          <Plans>
            <MPPlan xsi:nil="true" />
            <MPPlan xsi:nil="true" />
          </Plans>
          <ImageList>
            <MPImage xsi:nil="true" />
            <MPImage xsi:nil="true" />
          </ImageList>
          <FeatureList>
            <MPFeature xsi:nil="true" />
            <MPFeature xsi:nil="true" />
          </FeatureList>
          <ScheduleActive>boolean</ScheduleActive>
          <ScheduleActiveDate>dateTime</ScheduleActiveDate>
          <PriceUnit>decimal</PriceUnit>
          <CurrencyCode>string</CurrencyCode>
          <IsReserved>boolean</IsReserved>
          <CustomerPriceUnit>decimal</CustomerPriceUnit>
          <Condition>string</Condition>
          <ConditionNotes>string</ConditionNotes>
          <MPN>string</MPN>
          <Title>string</Title>
          <RetailPrice>decimal</RetailPrice>
          <Color>string</Color>
          <Type>string</Type>
          <Manufacturer>string</Manufacturer>
          <PartClass>string</PartClass>
          <PartGroup>string</PartGroup>
          <PartCategory>string</PartCategory>
          <PartSubCategory>string</PartSubCategory>
          <Weight>decimal</Weight>
          <MemorySize>string</MemorySize>
          <LongDescription>string</LongDescription>
          <DateModified>dateTime</DateModified>
          <Locked>string</Locked>
        </ResponseObject>
      </GetPartInfoByPartNumberResult>
    </GetPartInfoByPartNumberResponse>
  </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 /CatalogManagementService.asmx HTTP/1.1
Host: marketplace.cms.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>
    <GetPartInfoByPartNumber xmlns="http://svcs.marketplace.brightstar.com/">
      <request>
        <RequestObject>
          <CatalogPartMasterID>int</CatalogPartMasterID>
          <WarehouseID>int</WarehouseID>
          <CatalogID>int</CatalogID>
          <CarrierID>int</CarrierID>
          <CarrierName>string</CarrierName>
          <PartTypeID>int</PartTypeID>
          <PartNumber>string</PartNumber>
          <PartDescription>string</PartDescription>
          <UPCCode>string</UPCCode>
          <WebDescription>string</WebDescription>
          <VendorPartNumber>string</VendorPartNumber>
          <CustomerPartNumber>string</CustomerPartNumber>
          <CustomerEntityID>int</CustomerEntityID>
          <Model>string</Model>
          <AccessoryPartNumber>string</AccessoryPartNumber>
          <VendorAccessoryPartNumber>string</VendorAccessoryPartNumber>
          <Active>boolean</Active>
          <Available>boolean</Available>
          <QuantityReserved>int</QuantityReserved>
          <QuantityUnreserved>int</QuantityUnreserved>
          <QuantityStandard>int</QuantityStandard>
          <QuantityPreOrder>int</QuantityPreOrder>
          <IsReservable>boolean</IsReservable>
          <IsSimRequired>boolean</IsSimRequired>
          <IsAssociated>boolean</IsAssociated>
          <Plans>
            <MPPlan xsi:nil="true" />
            <MPPlan xsi:nil="true" />
          </Plans>
          <ImageList>
            <MPImage xsi:nil="true" />
            <MPImage xsi:nil="true" />
          </ImageList>
          <FeatureList>
            <MPFeature xsi:nil="true" />
            <MPFeature xsi:nil="true" />
          </FeatureList>
          <ScheduleActive>boolean</ScheduleActive>
          <ScheduleActiveDate>dateTime</ScheduleActiveDate>
          <PriceUnit>decimal</PriceUnit>
          <CurrencyCode>string</CurrencyCode>
          <IsReserved>boolean</IsReserved>
          <CustomerPriceUnit>decimal</CustomerPriceUnit>
          <Condition>string</Condition>
          <ConditionNotes>string</ConditionNotes>
          <MPN>string</MPN>
          <Title>string</Title>
          <RetailPrice>decimal</RetailPrice>
          <Color>string</Color>
          <Type>string</Type>
          <Manufacturer>string</Manufacturer>
          <PartClass>string</PartClass>
          <PartGroup>string</PartGroup>
          <PartCategory>string</PartCategory>
          <PartSubCategory>string</PartSubCategory>
          <Weight>decimal</Weight>
          <MemorySize>string</MemorySize>
          <LongDescription>string</LongDescription>
          <DateModified>dateTime</DateModified>
          <Locked>string</Locked>
        </RequestObject>
      </request>
    </GetPartInfoByPartNumber>
  </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>
    <GetPartInfoByPartNumberResponse xmlns="http://svcs.marketplace.brightstar.com/">
      <GetPartInfoByPartNumberResult>
        <ResponseObject>
          <CatalogPartMasterID>int</CatalogPartMasterID>
          <WarehouseID>int</WarehouseID>
          <CatalogID>int</CatalogID>
          <CarrierID>int</CarrierID>
          <CarrierName>string</CarrierName>
          <PartTypeID>int</PartTypeID>
          <PartNumber>string</PartNumber>
          <PartDescription>string</PartDescription>
          <UPCCode>string</UPCCode>
          <WebDescription>string</WebDescription>
          <VendorPartNumber>string</VendorPartNumber>
          <CustomerPartNumber>string</CustomerPartNumber>
          <CustomerEntityID>int</CustomerEntityID>
          <Model>string</Model>
          <AccessoryPartNumber>string</AccessoryPartNumber>
          <VendorAccessoryPartNumber>string</VendorAccessoryPartNumber>
          <Active>boolean</Active>
          <Available>boolean</Available>
          <QuantityReserved>int</QuantityReserved>
          <QuantityUnreserved>int</QuantityUnreserved>
          <QuantityStandard>int</QuantityStandard>
          <QuantityPreOrder>int</QuantityPreOrder>
          <IsReservable>boolean</IsReservable>
          <IsSimRequired>boolean</IsSimRequired>
          <IsAssociated>boolean</IsAssociated>
          <Plans>
            <MPPlan xsi:nil="true" />
            <MPPlan xsi:nil="true" />
          </Plans>
          <ImageList>
            <MPImage xsi:nil="true" />
            <MPImage xsi:nil="true" />
          </ImageList>
          <FeatureList>
            <MPFeature xsi:nil="true" />
            <MPFeature xsi:nil="true" />
          </FeatureList>
          <ScheduleActive>boolean</ScheduleActive>
          <ScheduleActiveDate>dateTime</ScheduleActiveDate>
          <PriceUnit>decimal</PriceUnit>
          <CurrencyCode>string</CurrencyCode>
          <IsReserved>boolean</IsReserved>
          <CustomerPriceUnit>decimal</CustomerPriceUnit>
          <Condition>string</Condition>
          <ConditionNotes>string</ConditionNotes>
          <MPN>string</MPN>
          <Title>string</Title>
          <RetailPrice>decimal</RetailPrice>
          <Color>string</Color>
          <Type>string</Type>
          <Manufacturer>string</Manufacturer>
          <PartClass>string</PartClass>
          <PartGroup>string</PartGroup>
          <PartCategory>string</PartCategory>
          <PartSubCategory>string</PartSubCategory>
          <Weight>decimal</Weight>
          <MemorySize>string</MemorySize>
          <LongDescription>string</LongDescription>
          <DateModified>dateTime</DateModified>
          <Locked>string</Locked>
        </ResponseObject>
      </GetPartInfoByPartNumberResult>
    </GetPartInfoByPartNumberResponse>
  </soap12:Body>
</soap12:Envelope>