FractusApi Web Service

FractusApi

Click here for a complete list of operations.

ShippingLabelForPackstation

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 /FractusApi.asmx HTTP/1.1
Host: fractusapi-vscm.azurewebsites.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://VisibleSCM.com/ShippingLabelForPackstation"

<?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>
    <ShippingLabelForPackstation xmlns="http://VisibleSCM.com/">
      <SecurityToken>string</SecurityToken>
      <request>
        <Carrier>string</Carrier>
        <ServiceType>string</ServiceType>
        <UniqueRequestId>string</UniqueRequestId>
        <IntegratorClientID>string</IntegratorClientID>
        <CustomText1>string</CustomText1>
        <CustomText2>string</CustomText2>
        <PreferredFormat>int</PreferredFormat>
        <PreferredSize>int</PreferredSize>
        <ShipDate>dateTime</ShipDate>
        <ToAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </ToAddress>
        <FromAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </FromAddress>
        <ReturnAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </ReturnAddress>
        <Packages>
          <RequestPackage>
            <PackageNumber>int</PackageNumber>
            <Height>decimal</Height>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <DimensionUnit>string</DimensionUnit>
            <Weight>decimal</Weight>
            <WeightUnit>string</WeightUnit>
            <PackageType>int</PackageType>
            <Value>decimal</Value>
            <CurrencyCode>string</CurrencyCode>
          </RequestPackage>
          <RequestPackage>
            <PackageNumber>int</PackageNumber>
            <Height>decimal</Height>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <DimensionUnit>string</DimensionUnit>
            <Weight>decimal</Weight>
            <WeightUnit>string</WeightUnit>
            <PackageType>int</PackageType>
            <Value>decimal</Value>
            <CurrencyCode>string</CurrencyCode>
          </RequestPackage>
        </Packages>
        <CustomsInfo>
          <ContentType>string</ContentType>
          <ContentDescription>string</ContentDescription>
          <InvoiceNumber>string</InvoiceNumber>
          <ImporterCustomsReference>string</ImporterCustomsReference>
          <InsuredNumber>string</InsuredNumber>
          <EELorPFC>string</EELorPFC>
          <LicenseNumber>string</LicenseNumber>
          <CertificateNumber>string</CertificateNumber>
          <NonDeliveryOption>string</NonDeliveryOption>
          <CustomsItems>
            <RequestCustomsItem xsi:nil="true" />
            <RequestCustomsItem xsi:nil="true" />
          </CustomsItems>
          <Certify>boolean</Certify>
          <CertifySigner>string</CertifySigner>
          <RestrictionType>string</RestrictionType>
          <RestrictionDescription>string</RestrictionDescription>
        </CustomsInfo>
      </request>
    </ShippingLabelForPackstation>
  </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>
    <ShippingLabelForPackstationResponse xmlns="http://VisibleSCM.com/">
      <ShippingLabelForPackstationResult>
        <UniqueRequestId>string</UniqueRequestId>
        <TransactionId>string</TransactionId>
        <CommercialInvoice>string</CommercialInvoice>
        <ToAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </ToAddress>
        <FromAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </FromAddress>
        <ReturnAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </ReturnAddress>
        <Package>
          <ResponsePackage>
            <Id>string</Id>
            <PackageNumber>string</PackageNumber>
            <TrackingNumber>string</TrackingNumber>
            <Carrier>string</Carrier>
            <Service>string</Service>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <ShipDate>dateTime</ShipDate>
            <Height>decimal</Height>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <DimensionUnit>string</DimensionUnit>
            <Weight>decimal</Weight>
            <WeightUnit>string</WeightUnit>
            <PackageType>string</PackageType>
            <Labels xsi:nil="true" />
            <Charges xsi:nil="true" />
          </ResponsePackage>
          <ResponsePackage>
            <Id>string</Id>
            <PackageNumber>string</PackageNumber>
            <TrackingNumber>string</TrackingNumber>
            <Carrier>string</Carrier>
            <Service>string</Service>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <ShipDate>dateTime</ShipDate>
            <Height>decimal</Height>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <DimensionUnit>string</DimensionUnit>
            <Weight>decimal</Weight>
            <WeightUnit>string</WeightUnit>
            <PackageType>string</PackageType>
            <Labels xsi:nil="true" />
            <Charges xsi:nil="true" />
          </ResponsePackage>
        </Package>
        <AdditionalDocuments>
          <AdditionalDocument>
            <DocumentType>string</DocumentType>
            <Document>string</Document>
            <DocumentFormat>string</DocumentFormat>
          </AdditionalDocument>
          <AdditionalDocument>
            <DocumentType>string</DocumentType>
            <Document>string</Document>
            <DocumentFormat>string</DocumentFormat>
          </AdditionalDocument>
        </AdditionalDocuments>
        <MetaData>
          <Key>string</Key>
          <Value>string</Value>
        </MetaData>
        <ResultMessage>string</ResultMessage>
        <ExecutionTimeInMS>int</ExecutionTimeInMS>
      </ShippingLabelForPackstationResult>
    </ShippingLabelForPackstationResponse>
  </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 /FractusApi.asmx HTTP/1.1
Host: fractusapi-vscm.azurewebsites.net
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>
    <ShippingLabelForPackstation xmlns="http://VisibleSCM.com/">
      <SecurityToken>string</SecurityToken>
      <request>
        <Carrier>string</Carrier>
        <ServiceType>string</ServiceType>
        <UniqueRequestId>string</UniqueRequestId>
        <IntegratorClientID>string</IntegratorClientID>
        <CustomText1>string</CustomText1>
        <CustomText2>string</CustomText2>
        <PreferredFormat>int</PreferredFormat>
        <PreferredSize>int</PreferredSize>
        <ShipDate>dateTime</ShipDate>
        <ToAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </ToAddress>
        <FromAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </FromAddress>
        <ReturnAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </ReturnAddress>
        <Packages>
          <RequestPackage>
            <PackageNumber>int</PackageNumber>
            <Height>decimal</Height>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <DimensionUnit>string</DimensionUnit>
            <Weight>decimal</Weight>
            <WeightUnit>string</WeightUnit>
            <PackageType>int</PackageType>
            <Value>decimal</Value>
            <CurrencyCode>string</CurrencyCode>
          </RequestPackage>
          <RequestPackage>
            <PackageNumber>int</PackageNumber>
            <Height>decimal</Height>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <DimensionUnit>string</DimensionUnit>
            <Weight>decimal</Weight>
            <WeightUnit>string</WeightUnit>
            <PackageType>int</PackageType>
            <Value>decimal</Value>
            <CurrencyCode>string</CurrencyCode>
          </RequestPackage>
        </Packages>
        <CustomsInfo>
          <ContentType>string</ContentType>
          <ContentDescription>string</ContentDescription>
          <InvoiceNumber>string</InvoiceNumber>
          <ImporterCustomsReference>string</ImporterCustomsReference>
          <InsuredNumber>string</InsuredNumber>
          <EELorPFC>string</EELorPFC>
          <LicenseNumber>string</LicenseNumber>
          <CertificateNumber>string</CertificateNumber>
          <NonDeliveryOption>string</NonDeliveryOption>
          <CustomsItems>
            <RequestCustomsItem xsi:nil="true" />
            <RequestCustomsItem xsi:nil="true" />
          </CustomsItems>
          <Certify>boolean</Certify>
          <CertifySigner>string</CertifySigner>
          <RestrictionType>string</RestrictionType>
          <RestrictionDescription>string</RestrictionDescription>
        </CustomsInfo>
      </request>
    </ShippingLabelForPackstation>
  </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>
    <ShippingLabelForPackstationResponse xmlns="http://VisibleSCM.com/">
      <ShippingLabelForPackstationResult>
        <UniqueRequestId>string</UniqueRequestId>
        <TransactionId>string</TransactionId>
        <CommercialInvoice>string</CommercialInvoice>
        <ToAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </ToAddress>
        <FromAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </FromAddress>
        <ReturnAddress>
          <Name>string</Name>
          <Company>string</Company>
          <Phone>string</Phone>
          <Email>string</Email>
          <IsResidential>boolean</IsResidential>
          <Description>string</Description>
          <Id>string</Id>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <City>string</City>
          <StateProvince>string</StateProvince>
          <PostalCode>string</PostalCode>
          <Country>string</Country>
          <Option>int</Option>
        </ReturnAddress>
        <Package>
          <ResponsePackage>
            <Id>string</Id>
            <PackageNumber>string</PackageNumber>
            <TrackingNumber>string</TrackingNumber>
            <Carrier>string</Carrier>
            <Service>string</Service>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <ShipDate>dateTime</ShipDate>
            <Height>decimal</Height>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <DimensionUnit>string</DimensionUnit>
            <Weight>decimal</Weight>
            <WeightUnit>string</WeightUnit>
            <PackageType>string</PackageType>
            <Labels xsi:nil="true" />
            <Charges xsi:nil="true" />
          </ResponsePackage>
          <ResponsePackage>
            <Id>string</Id>
            <PackageNumber>string</PackageNumber>
            <TrackingNumber>string</TrackingNumber>
            <Carrier>string</Carrier>
            <Service>string</Service>
            <EstimatedDeliveryDate>dateTime</EstimatedDeliveryDate>
            <ShipDate>dateTime</ShipDate>
            <Height>decimal</Height>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <DimensionUnit>string</DimensionUnit>
            <Weight>decimal</Weight>
            <WeightUnit>string</WeightUnit>
            <PackageType>string</PackageType>
            <Labels xsi:nil="true" />
            <Charges xsi:nil="true" />
          </ResponsePackage>
        </Package>
        <AdditionalDocuments>
          <AdditionalDocument>
            <DocumentType>string</DocumentType>
            <Document>string</Document>
            <DocumentFormat>string</DocumentFormat>
          </AdditionalDocument>
          <AdditionalDocument>
            <DocumentType>string</DocumentType>
            <Document>string</Document>
            <DocumentFormat>string</DocumentFormat>
          </AdditionalDocument>
        </AdditionalDocuments>
        <MetaData>
          <Key>string</Key>
          <Value>string</Value>
        </MetaData>
        <ResultMessage>string</ResultMessage>
        <ExecutionTimeInMS>int</ExecutionTimeInMS>
      </ShippingLabelForPackstationResult>
    </ShippingLabelForPackstationResponse>
  </soap12:Body>
</soap12:Envelope>