BackOffice Web Service

BackOffice

Click here for a complete list of operations.

ListProducts

Gets all the products from the system

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 /puckanetennisclub/app/BackOffice.asmx HTTP/1.1
Host: lightingsports.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.joycesoftware.com/ListProducts"

<?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>
    <ListProducts xmlns="http://www.joycesoftware.com" />
  </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>
    <ListProductsResponse xmlns="http://www.joycesoftware.com">
      <ListProductsResult>
        <Product>
          <Id>int</Id>
          <ProductGuid>string</ProductGuid>
          <Name>string</Name>
          <ShortDescription>string</ShortDescription>
          <FullDescription>string</FullDescription>
          <AdminComment>string</AdminComment>
          <MetaKeywords>string</MetaKeywords>
          <MetaDescription>string</MetaDescription>
          <MetaTitle>string</MetaTitle>
          <LimitedToStores>boolean</LimitedToStores>
          <Sku>string</Sku>
          <HasPOSMessage>boolean</HasPOSMessage>
          <POSMessageText>string</POSMessageText>
          <IsTaxExempt>boolean</IsTaxExempt>
          <TaxCategoryId>int</TaxCategoryId>
          <NotifyAdminForQuantityBelow>int</NotifyAdminForQuantityBelow>
          <NotReturnable>boolean</NotReturnable>
          <Price>decimal</Price>
          <OldPrice>decimal</OldPrice>
          <ManufacturerGUID>string</ManufacturerGUID>
          <ManufacturerPartNumber>string</ManufacturerPartNumber>
          <Gtin>string</Gtin>
          <ProductCost>decimal</ProductCost>
          <PackSize>decimal</PackSize>
          <UnitCost>decimal</UnitCost>
          <SpecialPrice>decimal</SpecialPrice>
          <SpecialPriceStartDateTimeUtc>dateTime</SpecialPriceStartDateTimeUtc>
          <SpecialPriceEndDateTimeUtc>dateTime</SpecialPriceEndDateTimeUtc>
          <Weight>decimal</Weight>
          <Length>decimal</Length>
          <Width>decimal</Width>
          <Height>decimal</Height>
          <Published>boolean</Published>
          <Deleted>boolean</Deleted>
          <CreatedOnUtc>dateTime</CreatedOnUtc>
          <UpdatedOnUtc>dateTime</UpdatedOnUtc>
          <CategoryGUID>string</CategoryGUID>
          <InternalPartNumber>string</InternalPartNumber>
          <PurchaseTaxCategoryId>int</PurchaseTaxCategoryId>
          <PrintPickingList>string</PrintPickingList>
          <ProductType>decimal</ProductType>
          <IsVeterinaryCascade>string</IsVeterinaryCascade>
          <PackDescription>string</PackDescription>
          <NoStockActivity>decimal</NoStockActivity>
          <PresetHeader>decimal</PresetHeader>
          <AverageCost>decimal</AverageCost>
          <SpecialOfferGUID>string</SpecialOfferGUID>
          <PurchaseSpecialOfferGUID>string</PurchaseSpecialOfferGUID>
          <ExternalProductType>string</ExternalProductType>
          <PricePerHour>decimal</PricePerHour>
          <PricePerDay>decimal</PricePerDay>
          <PricePerWeek>decimal</PricePerWeek>
          <PricePerMonth>decimal</PricePerMonth>
          <UnitofMeasure>string</UnitofMeasure>
          <IsBookable>string</IsBookable>
          <AgeRestriction>decimal</AgeRestriction>
          <IsRestricted>string</IsRestricted>
          <PhysicalStock>decimal</PhysicalStock>
          <BinLocation>string</BinLocation>
          <balances>
            <ProductBalance xsi:nil="true" />
            <ProductBalance xsi:nil="true" />
          </balances>
          <Barcodes>
            <ProductBarcodes xsi:nil="true" />
            <ProductBarcodes xsi:nil="true" />
          </Barcodes>
          <Batches>
            <ProductBatches xsi:nil="true" />
            <ProductBatches xsi:nil="true" />
          </Batches>
          <OnHireTill>string</OnHireTill>
          <CategoryName>string</CategoryName>
          <Percentage>decimal</Percentage>
        </Product>
        <Product>
          <Id>int</Id>
          <ProductGuid>string</ProductGuid>
          <Name>string</Name>
          <ShortDescription>string</ShortDescription>
          <FullDescription>string</FullDescription>
          <AdminComment>string</AdminComment>
          <MetaKeywords>string</MetaKeywords>
          <MetaDescription>string</MetaDescription>
          <MetaTitle>string</MetaTitle>
          <LimitedToStores>boolean</LimitedToStores>
          <Sku>string</Sku>
          <HasPOSMessage>boolean</HasPOSMessage>
          <POSMessageText>string</POSMessageText>
          <IsTaxExempt>boolean</IsTaxExempt>
          <TaxCategoryId>int</TaxCategoryId>
          <NotifyAdminForQuantityBelow>int</NotifyAdminForQuantityBelow>
          <NotReturnable>boolean</NotReturnable>
          <Price>decimal</Price>
          <OldPrice>decimal</OldPrice>
          <ManufacturerGUID>string</ManufacturerGUID>
          <ManufacturerPartNumber>string</ManufacturerPartNumber>
          <Gtin>string</Gtin>
          <ProductCost>decimal</ProductCost>
          <PackSize>decimal</PackSize>
          <UnitCost>decimal</UnitCost>
          <SpecialPrice>decimal</SpecialPrice>
          <SpecialPriceStartDateTimeUtc>dateTime</SpecialPriceStartDateTimeUtc>
          <SpecialPriceEndDateTimeUtc>dateTime</SpecialPriceEndDateTimeUtc>
          <Weight>decimal</Weight>
          <Length>decimal</Length>
          <Width>decimal</Width>
          <Height>decimal</Height>
          <Published>boolean</Published>
          <Deleted>boolean</Deleted>
          <CreatedOnUtc>dateTime</CreatedOnUtc>
          <UpdatedOnUtc>dateTime</UpdatedOnUtc>
          <CategoryGUID>string</CategoryGUID>
          <InternalPartNumber>string</InternalPartNumber>
          <PurchaseTaxCategoryId>int</PurchaseTaxCategoryId>
          <PrintPickingList>string</PrintPickingList>
          <ProductType>decimal</ProductType>
          <IsVeterinaryCascade>string</IsVeterinaryCascade>
          <PackDescription>string</PackDescription>
          <NoStockActivity>decimal</NoStockActivity>
          <PresetHeader>decimal</PresetHeader>
          <AverageCost>decimal</AverageCost>
          <SpecialOfferGUID>string</SpecialOfferGUID>
          <PurchaseSpecialOfferGUID>string</PurchaseSpecialOfferGUID>
          <ExternalProductType>string</ExternalProductType>
          <PricePerHour>decimal</PricePerHour>
          <PricePerDay>decimal</PricePerDay>
          <PricePerWeek>decimal</PricePerWeek>
          <PricePerMonth>decimal</PricePerMonth>
          <UnitofMeasure>string</UnitofMeasure>
          <IsBookable>string</IsBookable>
          <AgeRestriction>decimal</AgeRestriction>
          <IsRestricted>string</IsRestricted>
          <PhysicalStock>decimal</PhysicalStock>
          <BinLocation>string</BinLocation>
          <balances>
            <ProductBalance xsi:nil="true" />
            <ProductBalance xsi:nil="true" />
          </balances>
          <Barcodes>
            <ProductBarcodes xsi:nil="true" />
            <ProductBarcodes xsi:nil="true" />
          </Barcodes>
          <Batches>
            <ProductBatches xsi:nil="true" />
            <ProductBatches xsi:nil="true" />
          </Batches>
          <OnHireTill>string</OnHireTill>
          <CategoryName>string</CategoryName>
          <Percentage>decimal</Percentage>
        </Product>
      </ListProductsResult>
    </ListProductsResponse>
  </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 /puckanetennisclub/app/BackOffice.asmx HTTP/1.1
Host: lightingsports.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>
    <ListProducts xmlns="http://www.joycesoftware.com" />
  </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>
    <ListProductsResponse xmlns="http://www.joycesoftware.com">
      <ListProductsResult>
        <Product>
          <Id>int</Id>
          <ProductGuid>string</ProductGuid>
          <Name>string</Name>
          <ShortDescription>string</ShortDescription>
          <FullDescription>string</FullDescription>
          <AdminComment>string</AdminComment>
          <MetaKeywords>string</MetaKeywords>
          <MetaDescription>string</MetaDescription>
          <MetaTitle>string</MetaTitle>
          <LimitedToStores>boolean</LimitedToStores>
          <Sku>string</Sku>
          <HasPOSMessage>boolean</HasPOSMessage>
          <POSMessageText>string</POSMessageText>
          <IsTaxExempt>boolean</IsTaxExempt>
          <TaxCategoryId>int</TaxCategoryId>
          <NotifyAdminForQuantityBelow>int</NotifyAdminForQuantityBelow>
          <NotReturnable>boolean</NotReturnable>
          <Price>decimal</Price>
          <OldPrice>decimal</OldPrice>
          <ManufacturerGUID>string</ManufacturerGUID>
          <ManufacturerPartNumber>string</ManufacturerPartNumber>
          <Gtin>string</Gtin>
          <ProductCost>decimal</ProductCost>
          <PackSize>decimal</PackSize>
          <UnitCost>decimal</UnitCost>
          <SpecialPrice>decimal</SpecialPrice>
          <SpecialPriceStartDateTimeUtc>dateTime</SpecialPriceStartDateTimeUtc>
          <SpecialPriceEndDateTimeUtc>dateTime</SpecialPriceEndDateTimeUtc>
          <Weight>decimal</Weight>
          <Length>decimal</Length>
          <Width>decimal</Width>
          <Height>decimal</Height>
          <Published>boolean</Published>
          <Deleted>boolean</Deleted>
          <CreatedOnUtc>dateTime</CreatedOnUtc>
          <UpdatedOnUtc>dateTime</UpdatedOnUtc>
          <CategoryGUID>string</CategoryGUID>
          <InternalPartNumber>string</InternalPartNumber>
          <PurchaseTaxCategoryId>int</PurchaseTaxCategoryId>
          <PrintPickingList>string</PrintPickingList>
          <ProductType>decimal</ProductType>
          <IsVeterinaryCascade>string</IsVeterinaryCascade>
          <PackDescription>string</PackDescription>
          <NoStockActivity>decimal</NoStockActivity>
          <PresetHeader>decimal</PresetHeader>
          <AverageCost>decimal</AverageCost>
          <SpecialOfferGUID>string</SpecialOfferGUID>
          <PurchaseSpecialOfferGUID>string</PurchaseSpecialOfferGUID>
          <ExternalProductType>string</ExternalProductType>
          <PricePerHour>decimal</PricePerHour>
          <PricePerDay>decimal</PricePerDay>
          <PricePerWeek>decimal</PricePerWeek>
          <PricePerMonth>decimal</PricePerMonth>
          <UnitofMeasure>string</UnitofMeasure>
          <IsBookable>string</IsBookable>
          <AgeRestriction>decimal</AgeRestriction>
          <IsRestricted>string</IsRestricted>
          <PhysicalStock>decimal</PhysicalStock>
          <BinLocation>string</BinLocation>
          <balances>
            <ProductBalance xsi:nil="true" />
            <ProductBalance xsi:nil="true" />
          </balances>
          <Barcodes>
            <ProductBarcodes xsi:nil="true" />
            <ProductBarcodes xsi:nil="true" />
          </Barcodes>
          <Batches>
            <ProductBatches xsi:nil="true" />
            <ProductBatches xsi:nil="true" />
          </Batches>
          <OnHireTill>string</OnHireTill>
          <CategoryName>string</CategoryName>
          <Percentage>decimal</Percentage>
        </Product>
        <Product>
          <Id>int</Id>
          <ProductGuid>string</ProductGuid>
          <Name>string</Name>
          <ShortDescription>string</ShortDescription>
          <FullDescription>string</FullDescription>
          <AdminComment>string</AdminComment>
          <MetaKeywords>string</MetaKeywords>
          <MetaDescription>string</MetaDescription>
          <MetaTitle>string</MetaTitle>
          <LimitedToStores>boolean</LimitedToStores>
          <Sku>string</Sku>
          <HasPOSMessage>boolean</HasPOSMessage>
          <POSMessageText>string</POSMessageText>
          <IsTaxExempt>boolean</IsTaxExempt>
          <TaxCategoryId>int</TaxCategoryId>
          <NotifyAdminForQuantityBelow>int</NotifyAdminForQuantityBelow>
          <NotReturnable>boolean</NotReturnable>
          <Price>decimal</Price>
          <OldPrice>decimal</OldPrice>
          <ManufacturerGUID>string</ManufacturerGUID>
          <ManufacturerPartNumber>string</ManufacturerPartNumber>
          <Gtin>string</Gtin>
          <ProductCost>decimal</ProductCost>
          <PackSize>decimal</PackSize>
          <UnitCost>decimal</UnitCost>
          <SpecialPrice>decimal</SpecialPrice>
          <SpecialPriceStartDateTimeUtc>dateTime</SpecialPriceStartDateTimeUtc>
          <SpecialPriceEndDateTimeUtc>dateTime</SpecialPriceEndDateTimeUtc>
          <Weight>decimal</Weight>
          <Length>decimal</Length>
          <Width>decimal</Width>
          <Height>decimal</Height>
          <Published>boolean</Published>
          <Deleted>boolean</Deleted>
          <CreatedOnUtc>dateTime</CreatedOnUtc>
          <UpdatedOnUtc>dateTime</UpdatedOnUtc>
          <CategoryGUID>string</CategoryGUID>
          <InternalPartNumber>string</InternalPartNumber>
          <PurchaseTaxCategoryId>int</PurchaseTaxCategoryId>
          <PrintPickingList>string</PrintPickingList>
          <ProductType>decimal</ProductType>
          <IsVeterinaryCascade>string</IsVeterinaryCascade>
          <PackDescription>string</PackDescription>
          <NoStockActivity>decimal</NoStockActivity>
          <PresetHeader>decimal</PresetHeader>
          <AverageCost>decimal</AverageCost>
          <SpecialOfferGUID>string</SpecialOfferGUID>
          <PurchaseSpecialOfferGUID>string</PurchaseSpecialOfferGUID>
          <ExternalProductType>string</ExternalProductType>
          <PricePerHour>decimal</PricePerHour>
          <PricePerDay>decimal</PricePerDay>
          <PricePerWeek>decimal</PricePerWeek>
          <PricePerMonth>decimal</PricePerMonth>
          <UnitofMeasure>string</UnitofMeasure>
          <IsBookable>string</IsBookable>
          <AgeRestriction>decimal</AgeRestriction>
          <IsRestricted>string</IsRestricted>
          <PhysicalStock>decimal</PhysicalStock>
          <BinLocation>string</BinLocation>
          <balances>
            <ProductBalance xsi:nil="true" />
            <ProductBalance xsi:nil="true" />
          </balances>
          <Barcodes>
            <ProductBarcodes xsi:nil="true" />
            <ProductBarcodes xsi:nil="true" />
          </Barcodes>
          <Batches>
            <ProductBatches xsi:nil="true" />
            <ProductBatches xsi:nil="true" />
          </Batches>
          <OnHireTill>string</OnHireTill>
          <CategoryName>string</CategoryName>
          <Percentage>decimal</Percentage>
        </Product>
      </ListProductsResult>
    </ListProductsResponse>
  </soap12:Body>
</soap12:Envelope>