EwsLabelService

Click here for a complete list of operations.

CreateBranding

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 /LabelService/EwsLabelService.asmx HTTP/1.1
Host: labelserver.endicia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.envmgr.com/LabelService/CreateBranding"

<?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>
    <CreateBranding xmlns="www.envmgr.com/LabelService">
      <CreateBrandingRequest>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <BrandingProperties>
          <ReturnPolicy>string</ReturnPolicy>
          <Email>string</Email>
          <Phone>string</Phone>
          <LogoTargetUrl>string</LogoTargetUrl>
          <BrandName>string</BrandName>
          <LogoUrl>string</LogoUrl>
          <LogoType>string</LogoType>
          <MenuLinks>
            <MenuLink xsi:nil="true" />
            <MenuLink xsi:nil="true" />
          </MenuLinks>
          <SocialMedia>
            <SocialMedia xsi:nil="true" />
            <SocialMedia xsi:nil="true" />
          </SocialMedia>
          <Toggles>
            <ShowCustomColors>boolean</ShowCustomColors>
            <ShowSocialMedia>boolean</ShowSocialMedia>
            <ShowStoreUrl>boolean</ShowStoreUrl>
            <ShowMenuLinks>boolean</ShowMenuLinks>
            <ShowReturnPolicy>boolean</ShowReturnPolicy>
            <ShowEmail>boolean</ShowEmail>
            <ShowPhone>boolean</ShowPhone>
            <ShowShipmentDetails>boolean</ShowShipmentDetails>
            <ShowItemImages>boolean</ShowItemImages>
            <ShowShipmentPrices>boolean</ShowShipmentPrices>
            <ShowStoreAddress>boolean</ShowStoreAddress>
          </Toggles>
          <Colors>
            <Primary>string</Primary>
            <Secondary>string</Secondary>
            <Tertiary>string</Tertiary>
          </Colors>
          <Theme>string</Theme>
        </BrandingProperties>
        <Reference>string</Reference>
        <SetAsDefault>boolean</SetAsDefault>
      </CreateBrandingRequest>
    </CreateBranding>
  </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>
    <CreateBrandingResponse xmlns="www.envmgr.com/LabelService">
      <GetBrandingResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <BrandingID>string</BrandingID>
      </GetBrandingResponse>
    </CreateBrandingResponse>
  </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 /LabelService/EwsLabelService.asmx HTTP/1.1
Host: labelserver.endicia.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>
    <CreateBranding xmlns="www.envmgr.com/LabelService">
      <CreateBrandingRequest>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <BrandingProperties>
          <ReturnPolicy>string</ReturnPolicy>
          <Email>string</Email>
          <Phone>string</Phone>
          <LogoTargetUrl>string</LogoTargetUrl>
          <BrandName>string</BrandName>
          <LogoUrl>string</LogoUrl>
          <LogoType>string</LogoType>
          <MenuLinks>
            <MenuLink xsi:nil="true" />
            <MenuLink xsi:nil="true" />
          </MenuLinks>
          <SocialMedia>
            <SocialMedia xsi:nil="true" />
            <SocialMedia xsi:nil="true" />
          </SocialMedia>
          <Toggles>
            <ShowCustomColors>boolean</ShowCustomColors>
            <ShowSocialMedia>boolean</ShowSocialMedia>
            <ShowStoreUrl>boolean</ShowStoreUrl>
            <ShowMenuLinks>boolean</ShowMenuLinks>
            <ShowReturnPolicy>boolean</ShowReturnPolicy>
            <ShowEmail>boolean</ShowEmail>
            <ShowPhone>boolean</ShowPhone>
            <ShowShipmentDetails>boolean</ShowShipmentDetails>
            <ShowItemImages>boolean</ShowItemImages>
            <ShowShipmentPrices>boolean</ShowShipmentPrices>
            <ShowStoreAddress>boolean</ShowStoreAddress>
          </Toggles>
          <Colors>
            <Primary>string</Primary>
            <Secondary>string</Secondary>
            <Tertiary>string</Tertiary>
          </Colors>
          <Theme>string</Theme>
        </BrandingProperties>
        <Reference>string</Reference>
        <SetAsDefault>boolean</SetAsDefault>
      </CreateBrandingRequest>
    </CreateBranding>
  </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>
    <CreateBrandingResponse xmlns="www.envmgr.com/LabelService">
      <GetBrandingResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <BrandingID>string</BrandingID>
      </GetBrandingResponse>
    </CreateBrandingResponse>
  </soap12:Body>
</soap12:Envelope>