Field Squared API Services

PricingList

Represents a DTO for a pricing list in a workspace. Calls without an ObjectId will retrieve an array of all active pricing list objects for the workspace.

The following routes are available for this service:
GET,POST,PUT,DELETE	/{Workspace}/PricingList/{ObjectId}
GET	/{Workspace}/PricingList

**PricingList** Parameters:
Name	Parameter	Data Type	Required
Workspace	path	string	No
ObjectId	path	string	No
VersionId	body	string	No
BasedOn	body	string	No
Name	body	string	No
Categories	body	List<PricingListCat>	No
Items	body	List<PricingListItem>	No

**PricingListCat** Parameters:
Name	Parameter	Data Type	Required
ObjectId	form	string	No
Name	form	string	No
Categories	form	List<PricingListCat>	No
Items	form	List<PricingListItem>	No

**PricingListItem** Parameters:
Name	Parameter	Data Type	Required
ObjectId	form	string	No
Description	form	string	No
Details	form	string	No
Manufacturer	form	string	No
Model	form	string	No
Photo	form	string	No
IsTaxable	form	bool	No
Unit	form	string	No
UnitPrice	form	double	No
Barcode	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/PricingList/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PricingList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.PricingLists">
  <BasedOn>String</BasedOn>
  <Categories>
    <PricingListCat>
      <Categories>
        <PricingListCat>
          <Categories>
            <PricingListCat>
              <Categories i:nil="true" />
              <Items>
                <PricingListItem>
                  <Barcode>String</Barcode>
                  <Description>String</Description>
                  <Details>String</Details>
                  <IsTaxable>false</IsTaxable>
                  <Manufacturer>String</Manufacturer>
                  <Model>String</Model>
                  <ObjectId>String</ObjectId>
                  <Photo>String</Photo>
                  <Unit>String</Unit>
                  <UnitPrice>0</UnitPrice>
                </PricingListItem>
              </Items>
              <Name>String</Name>
              <ObjectId>String</ObjectId>
            </PricingListCat>
          </Categories>
          <Items>
            <PricingListItem>
              <Barcode>String</Barcode>
              <Description>String</Description>
              <Details>String</Details>
              <IsTaxable>false</IsTaxable>
              <Manufacturer>String</Manufacturer>
              <Model>String</Model>
              <ObjectId>String</ObjectId>
              <Photo>String</Photo>
              <Unit>String</Unit>
              <UnitPrice>0</UnitPrice>
            </PricingListItem>
          </Items>
          <Name>String</Name>
          <ObjectId>String</ObjectId>
        </PricingListCat>
      </Categories>
      <Items>
        <PricingListItem>
          <Barcode>String</Barcode>
          <Description>String</Description>
          <Details>String</Details>
          <IsTaxable>false</IsTaxable>
          <Manufacturer>String</Manufacturer>
          <Model>String</Model>
          <ObjectId>String</ObjectId>
          <Photo>String</Photo>
          <Unit>String</Unit>
          <UnitPrice>0</UnitPrice>
        </PricingListItem>
      </Items>
      <Name>String</Name>
      <ObjectId>String</ObjectId>
    </PricingListCat>
  </Categories>
  <Items>
    <PricingListItem>
      <Barcode>String</Barcode>
      <Description>String</Description>
      <Details>String</Details>
      <IsTaxable>false</IsTaxable>
      <Manufacturer>String</Manufacturer>
      <Model>String</Model>
      <ObjectId>String</ObjectId>
      <Photo>String</Photo>
      <Unit>String</Unit>
      <UnitPrice>0</UnitPrice>
    </PricingListItem>
  </Items>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</PricingList>