API Documentation

Supplier Methods

GET list Return a list of all suppliers
GET get/[id] Detailed information for a specific supplier
POST add Add a supplier and contacts
PUT update Update a suppliers details
PUT archive Archive a supplier
POST delete Delete a supplier
GET contact/[id] Detailed information for a specific contact
PUT contact/[id] Update a contacts details
POST contact add a contact to a supplier
PARAMETERS
detailed=true Optional Return detailed information of supplier. See GET get/[id] method for example of detailed supplier response.
EXAMPLE URL
https://api.workflowmax.com/supplier.api/list?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response
<Response>
  <Status>OK</Status> 
  <Suppliers>
    <Supplier>
      <ID>255</ID> 
      <Name>XYZ Australia, NZ Business Unit</Name> 
      <Address /> 
      <City /> 
      <Region /> 
      <PostCode /> 
      <Country /> 
      <PostalAddress>
         Level 32, PWC Building 
         188 Quay Street
         Auckland Central
      </PostalAddress> 
      <PostalCity>Auckland</PostalCity> 
      <PostalRegion /> 
      <PostalPostCode>1001</PostalPostCode>  
      <PostalCountry /> 
      <Phone /> 
      <Fax /> 
      <Website /> 
      <Contacts>
        <Contact>
          <ID>220</ID> 
          <Name>Samantha Benecke</Name> 
          <Mobile /> 
          <Email /> 
          <Phone /> 
          <Position /> 
        </Contact>
      </Contacts>
    </Supplier>
    <Supplier>
      <ID>697</ID> 
      <Name>A. Dutchess</Name> 
      <Address /> 
      <City /> 
      <Region /> 
      <PostCode /> 
      <Country /> 
      <PostalAddress>P O Box 123</PostalAddress> 
      <PostalCity>Wellington</PostalCity> 
      <PostalRegion /> 
      <PostalPostCode>6011</PostalPostCode>  
      <PostalCountry />
      <Phone /> 
      <Fax /> 
      <Website /> 
      <Contacts /> 
    </Supplier>
  </Suppliers>
</Response>
EXAMPLE URL
https://api.workflowmax.com/supplier.api/get/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response
<Response>
  <Status>OK</Status> 
  <Supplier>
    <ID>218</ID> 
    <Name>Acmer Pty Ltd</Name> 
    <Address /> 
    <City /> 
    <Region /> 
    <PostCode /> 
    <Country /> 
    <PostalAddress>
       Level 32, PWC Building 
       188 Quay Street
       Auckland Central
    </PostalAddress> 
    <PostalCity>Auckland</PostalCity> 
    <PostalRegion /> 
    <PostalPostCode>1001</PostalPostCode>  
    <PostalCountry /> 
    <Phone>(02) 1723 5265</Phone> 
    <Fax /> 
    <Website /> 
    <Contacts>
      <Contact>
        <ID>193</ID> 
        <Name>Wyett E Coyote</Name> 
        <Mobile /> 
        <Email /> 
        <Phone /> 
        <Position /> 
      </Contact>
    </Contacts>
    <Notes>
      <Note>
        <Title>note title</Title> 
        <Text>subject of the note</Text> 
        <Folder /> 
        <Date>2008-09-12T13:00:00</Date> 
        <CreatedBy>Jo Bloggs</CreatedBy>
      </Note>
    </Notes>
  </Supplier>
</Response>
EXAMPLE URL
POST https://api.workflowmax.com/supplier.api/add?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message
 
<Supplier>
  <Name>Bloggs Electrical Ltd</Name>
  <Address></Address>  <!-- optional -->   
  <City></City>  <!-- optional -->   
  <Region></Region>  <!-- optional -->   
  <PostCode></PostCode>  <!-- optional -->   
  <Country></Country>  <!-- optional -->   
  <PostalAddress></PostalAddress>  <!-- optional -->   
  <PostalCity></PostalCity>  <!-- optional -->   
  <PostalRegion></PostalRegion>  <!-- optional -->   
  <PostalPostCode></PostalPostCode>  <!-- optional -->   
  <PostalCountry></PostalCountry>  <!-- optional -->   
  <Phone></Phone>  <!-- optional -->   
  <Fax></Fax>  <!-- optional -->   
  <WebSite></WebSite>  <!-- optional -->   
  <Contacts>
    <Contact>
      <Name>Jo Bloggs</Name>   
      <Phone></Phone>  <!-- optional -->   
      <Mobile></Mobile>  <!-- optional -->   
      <Email></Email>  <!-- optional -->   
      <Position></Position>  <!-- optional -->   
    </Contact>
  </Contacts>
</Supplier>

The response will include the detailed information of the supplier as per the GET get/[id] method

EXAMPLE URL
PUT https://api.workflowmax.com/supplier.api/update?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message
<Supplier>
  <ID>1234</ID>
  <Name>Bloggs Electrical Ltd</Name>
  <Address></Address>  <!-- optional -->   
  <City></City>  <!-- optional -->   
  <Region></Region>  <!-- optional -->   
  <PostCode></PostCode>  <!-- optional -->   
  <Country></Country>  <!-- optional -->   
  <PostalAddress></PostalAddress>  <!-- optional -->   
  <PostalCity></PostalCity>  <!-- optional -->   
  <PostalRegion></PostalRegion>  <!-- optional -->   
  <PostalPostCode></PostalPostCode>  <!-- optional -->   
  <PostalCountry></PostalCountry>  <!-- optional -->   
  <Phone></Phone>  <!-- optional -->   
  <Fax></Fax>  <!-- optional -->   
  <WebSite></WebSite>  <!-- optional -->   
  <ReferralSourcee></ReferralSource>  <!-- optional -->   
</Supplier>
EXAMPLE URL
PUT https://api.workflowmax.com/supplier.api/archive?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message
<Supplier>
  <ID>1234</ID>
</Supplier>

The response will include the detailed information of the supplier as per the GET get/[id] method

EXAMPLE URL
POST https://api.workflowmax.com/supplier.api/delete?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message
<Supplier>
  <ID>1234</ID>
</Supplier>

The response will include the detailed information of the supplier as per the GET get/[id] method

EXAMPLE URL
https://api.workflowmax.com/supplier.api/contact/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response
<Response>
  <Status>OK</Status> 
  <Contact>
    <ID>123</ID> 
    <Name>Wyett E Coyote</Name> 
    <Mobile /> 
    <Email /> 
    <Phone /> 
    <Position /> 
  </Contact>
</Response>
EXAMPLE URL
PUT https://api.workflowmax.com/supplier.api/contact/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message
<Contact>
  <Name>Wyett E Coyote</Name> 
  <Mobile /> 
  <Email /> 
  <Phone /> 
  <Position /> 
</Contact>

The response will include the detailed information of the contact as per the GET contact/[id] method

EXAMPLE URL
POST https://api.workflowmax.com/supplier.api/contact?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message
<Contact>
  <Supplier>
    <ID>142</ID> 
  </Supplier>
  <Name>Wyett E Coyote</Name> 
  <Mobile /> 
  <Email /> 
  <Phone /> 
  <Position /> 
</Contact>

The response will include the detailed information of the contact as per the GET contact/[id] method

No credit card required.