H2OAPIv20

Click here for a complete list of operations.

Orders_Update

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 /v20/default.asmx HTTP/1.1
Host: api.rev.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.myh2o.com/v20/Orders_Update"

<?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>
    <Orders_Update xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <OrderID>int</OrderID>
        <Status>NOT_SPECIFIED or NEW or SENT or ERROR or CONFIRMED or COMPLETE or CANCELED or HOLD or FLOW_ERROR or PAYMENT_HOLD or LIFELINE_HOLD or JEOPARDY or PROVISIONED</Status>
        <StatusNote>string</StatusNote>
        <FlowThroughFlag>boolean</FlowThroughFlag>
        <CompletionDate>dateTime</CompletionDate>
        <TrackingNumber>string</TrackingNumber>
        <ShippingStatus>NOT_REQUIRED or NOT_SHIPPED or SHIPPED</ShippingStatus>
        <ProcessID>int</ProcessID>
        <ProcessRouteID>int</ProcessRouteID>
        <Lines>
          <OrderLineUpdateItem>
            <LineID>int</LineID>
            <TN>string</TN>
            <Products>
              <Add>
                <ProductID>int</ProductID>
                <Rate>decimal</Rate>
                <Quantity>int</Quantity>
              </Add>
              <Change>
                <CustomerProductID>int</CustomerProductID>
                <Rate>decimal</Rate>
                <Quantity>int</Quantity>
              </Change>
              <Remove>
                <CustomerProductID>int</CustomerProductID>
              </Remove>
            </Products>
          </OrderLineUpdateItem>
          <OrderLineUpdateItem>
            <LineID>int</LineID>
            <TN>string</TN>
            <Products>
              <Add>
                <ProductID>int</ProductID>
                <Rate>decimal</Rate>
                <Quantity>int</Quantity>
              </Add>
              <Change>
                <CustomerProductID>int</CustomerProductID>
                <Rate>decimal</Rate>
                <Quantity>int</Quantity>
              </Change>
              <Remove>
                <CustomerProductID>int</CustomerProductID>
              </Remove>
            </Products>
          </OrderLineUpdateItem>
        </Lines>
      </Request>
    </Orders_Update>
  </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>
    <Orders_UpdateResponse xmlns="http://api.myh2o.com/v20">
      <Orders_UpdateResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <OrderID>int</OrderID>
            <Status>NOT_SPECIFIED or NEW or SENT or ERROR or CONFIRMED or COMPLETE or CANCELED or HOLD or FLOW_ERROR or PAYMENT_HOLD or LIFELINE_HOLD or JEOPARDY or PROVISIONED</Status>
            <StatusNote>string</StatusNote>
            <FlowThroughFlag>boolean</FlowThroughFlag>
            <CompletionDate>dateTime</CompletionDate>
            <TrackingNumber>string</TrackingNumber>
            <ShippingStatus>NOT_REQUIRED or NOT_SHIPPED or SHIPPED</ShippingStatus>
            <ProcessID>int</ProcessID>
            <ProcessRouteID>int</ProcessRouteID>
            <Lines>
              <OrderLineUpdateItem>
                <LineID>int</LineID>
                <TN>string</TN>
                <Products>
                  <Add>
                    <ProductID>int</ProductID>
                    <Rate>decimal</Rate>
                    <Quantity>int</Quantity>
                  </Add>
                  <Change>
                    <CustomerProductID>int</CustomerProductID>
                    <Rate>decimal</Rate>
                    <Quantity>int</Quantity>
                  </Change>
                  <Remove>
                    <CustomerProductID>int</CustomerProductID>
                  </Remove>
                </Products>
              </OrderLineUpdateItem>
              <OrderLineUpdateItem>
                <LineID>int</LineID>
                <TN>string</TN>
                <Products>
                  <Add>
                    <ProductID>int</ProductID>
                    <Rate>decimal</Rate>
                    <Quantity>int</Quantity>
                  </Add>
                  <Change>
                    <CustomerProductID>int</CustomerProductID>
                    <Rate>decimal</Rate>
                    <Quantity>int</Quantity>
                  </Change>
                  <Remove>
                    <CustomerProductID>int</CustomerProductID>
                  </Remove>
                </Products>
              </OrderLineUpdateItem>
            </Lines>
          </Request>
        </Debug>
      </Orders_UpdateResult>
    </Orders_UpdateResponse>
  </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 /v20/default.asmx HTTP/1.1
Host: api.rev.io
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>
    <Orders_Update xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <OrderID>int</OrderID>
        <Status>NOT_SPECIFIED or NEW or SENT or ERROR or CONFIRMED or COMPLETE or CANCELED or HOLD or FLOW_ERROR or PAYMENT_HOLD or LIFELINE_HOLD or JEOPARDY or PROVISIONED</Status>
        <StatusNote>string</StatusNote>
        <FlowThroughFlag>boolean</FlowThroughFlag>
        <CompletionDate>dateTime</CompletionDate>
        <TrackingNumber>string</TrackingNumber>
        <ShippingStatus>NOT_REQUIRED or NOT_SHIPPED or SHIPPED</ShippingStatus>
        <ProcessID>int</ProcessID>
        <ProcessRouteID>int</ProcessRouteID>
        <Lines>
          <OrderLineUpdateItem>
            <LineID>int</LineID>
            <TN>string</TN>
            <Products>
              <Add>
                <ProductID>int</ProductID>
                <Rate>decimal</Rate>
                <Quantity>int</Quantity>
              </Add>
              <Change>
                <CustomerProductID>int</CustomerProductID>
                <Rate>decimal</Rate>
                <Quantity>int</Quantity>
              </Change>
              <Remove>
                <CustomerProductID>int</CustomerProductID>
              </Remove>
            </Products>
          </OrderLineUpdateItem>
          <OrderLineUpdateItem>
            <LineID>int</LineID>
            <TN>string</TN>
            <Products>
              <Add>
                <ProductID>int</ProductID>
                <Rate>decimal</Rate>
                <Quantity>int</Quantity>
              </Add>
              <Change>
                <CustomerProductID>int</CustomerProductID>
                <Rate>decimal</Rate>
                <Quantity>int</Quantity>
              </Change>
              <Remove>
                <CustomerProductID>int</CustomerProductID>
              </Remove>
            </Products>
          </OrderLineUpdateItem>
        </Lines>
      </Request>
    </Orders_Update>
  </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>
    <Orders_UpdateResponse xmlns="http://api.myh2o.com/v20">
      <Orders_UpdateResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <OrderID>int</OrderID>
            <Status>NOT_SPECIFIED or NEW or SENT or ERROR or CONFIRMED or COMPLETE or CANCELED or HOLD or FLOW_ERROR or PAYMENT_HOLD or LIFELINE_HOLD or JEOPARDY or PROVISIONED</Status>
            <StatusNote>string</StatusNote>
            <FlowThroughFlag>boolean</FlowThroughFlag>
            <CompletionDate>dateTime</CompletionDate>
            <TrackingNumber>string</TrackingNumber>
            <ShippingStatus>NOT_REQUIRED or NOT_SHIPPED or SHIPPED</ShippingStatus>
            <ProcessID>int</ProcessID>
            <ProcessRouteID>int</ProcessRouteID>
            <Lines>
              <OrderLineUpdateItem>
                <LineID>int</LineID>
                <TN>string</TN>
                <Products>
                  <Add>
                    <ProductID>int</ProductID>
                    <Rate>decimal</Rate>
                    <Quantity>int</Quantity>
                  </Add>
                  <Change>
                    <CustomerProductID>int</CustomerProductID>
                    <Rate>decimal</Rate>
                    <Quantity>int</Quantity>
                  </Change>
                  <Remove>
                    <CustomerProductID>int</CustomerProductID>
                  </Remove>
                </Products>
              </OrderLineUpdateItem>
              <OrderLineUpdateItem>
                <LineID>int</LineID>
                <TN>string</TN>
                <Products>
                  <Add>
                    <ProductID>int</ProductID>
                    <Rate>decimal</Rate>
                    <Quantity>int</Quantity>
                  </Add>
                  <Change>
                    <CustomerProductID>int</CustomerProductID>
                    <Rate>decimal</Rate>
                    <Quantity>int</Quantity>
                  </Change>
                  <Remove>
                    <CustomerProductID>int</CustomerProductID>
                  </Remove>
                </Products>
              </OrderLineUpdateItem>
            </Lines>
          </Request>
        </Debug>
      </Orders_UpdateResult>
    </Orders_UpdateResponse>
  </soap12:Body>
</soap12:Envelope>