Overview

The purpose of this method is to submit shipment data and produce a carrier compliant label. The shipment data will be validated against the carrier’s requirements and restrictions. If the shipment is successfully validated then a shipment label will be returned within the response; otherwise, the reason the shipment was not validated will be advised.

The function and output of AbolSimpleShipment is identical to that of the AbolShipment method. The main difference is that this method offers simplified objects that will cover the needs for basic processing for domestic and international shipments.

List Of Parameters

Download PDF

Request Layout

AbolSimpleShipment
  └── AbolSimpleShipment
      └── AbolSimpleShip
          └── Request
          │   ├── Authentication
          │   ├── ActivationKey
          │   ├── LoginName
          │   ├── Password
          │   └── AltID
          └── SimpleShipment
              ├── CarrierId
              ├── BillType
              ├── BillAccountNumber
              ├── BillAccountZipCode
              ├── DriverInstructions
              ├── ResidentialFlag
              ├── SaturdayDeliveryFlag
              ├── SaturdayPickupFlag
              ├── LabelType
              ├── LabelSize
              ├── HolidayDeliveryFlag
              ├── SundayDeliveryFlag
              ├── DimensionUnit
              ├── WeightUnit
              ├── ShipDate
              ├── ServiceCode
              ├── DeclaredValue
              ├── CurrencyCode
              ├── DimWeight
              ├── TrackingNumber
              ├── Length
              ├── Height
              ├── Width
              ├── PackagingType
              ├── ReferenceNumber
              ├── Weight
              ├── AddlPackageReference1
              ├── AddlPackageReference2
              ├── AddlPackageReference3
              ├── AddlPackageReference4
              ├── AddlPackageReference5
              ├── AddlPackageReference6
              ├── AddlPackageReference7
              ├── AddlPackageReference8
              ├── ContentDescription
              ├── NotificationType
              ├── NotificationValue
              ├── ImageRotation
              ├── EveningDeliveryFlag
              ├── ReturnType
              ├── ReturnServiceCode
              ├── DeliveryConfirmationFlag
              ├── SignatureConfirmationFlag
              ├── SignatureConfirmationType
              ├── InsuranceAmount
              ├── InsurancePayType
              ├── InsuranceType
              ├── EndorsementType
              ├── OverrideShipToAddressValidationFlag
              ├── ShipFrom
              │   ├── Company
              │   ├── Attn
              │   ├── AddressLine1
              │   ├── AddressLine2
              │   ├── AddressLine3
              │   ├── City
              │   ├── StateCode
              │   ├── Zip
              │   ├── Zip4
              │   ├── CountryCode
              │   ├── CountryName
              │   ├── PhoneAreaCode
              │   ├── Phone
              │   ├── PhoneExt
              │   ├── Fax
              │   ├── EMail
              │   ├── Department
              │   ├── Reference
              │   ├── ResidentialFlag
              │   └── IsPOBox
              ├── ShipTo
              │   ├── Company
              │   ├── Attn
              │   ├── AddressLine1
              │   ├── AddressLine2
              │   ├── AddressLine3
              │   ├── City
              │   ├── StateCode
              │   ├── Zip
              │   ├── Zip4
              │   ├── CountryCode
              │   ├── CountryName
              │   ├── PhoneAreaCode
              │   ├── Phone
              │   ├── PhoneExt
              │   ├── Fax
              │   ├── EMail
              │   ├── Department
              │   ├── Reference
              │   ├── ResidentialFlag
              │   ├── IsPOBox
              ├── Return
              │   ├── Company
              │   ├── Attn
              │   ├── AddressLine1
              │   ├── AddressLine2
              │   ├── AddressLine3
              │   ├── City
              │   ├── StateCode
              │   ├── Zip
              │   ├── Zip4
              │   ├── CountryCode
              │   ├── CountryName
              │   ├── PhoneAreaCode
              │   ├── Phone
              │   ├── PhoneExt
              │   ├── Fax
              │   ├── EMail
              │   ├── Department
              │   ├── Reference
              │   ├── ResidentialFlag
              │   └── IsPOBox
              ├── SimpleInternationalShipment
              │   ├── DeclaredValue
              │   ├── CN22DescriptionType
              │   ├── Incoterms
              │   ├── ExportReasonCode
              │   ├── ShipperEin
              │   ├── SEDFilingOption
              │   ├── AESTransactionNumber
              │   ├── FTRExemtionCode
              │   ├── FormRequested
              │   ├── FormGenerationType
              │   ├── ExportType
              │   ├── ExceptionCode
              │   ├── CustomFormType
              │   ├── DutyAccountNumber
              │   ├── DutyBillType
              │   ├── DutyServiceType
              │   ├── IncludeDutyCalculation
              │   ├── CommercialImporterFlag
              │   ├── TotalMonthlyImportedWeight
              │   └── TotalMonthlyImportedValue
              └── SimpleExportLineItemList
                  └── SimpleExportLineItem
                      ├── Code
                      ├── Description
                      ├── Weight
                      ├── UnitWeight
                      ├── Price
                      ├── Quantity
                      ├── UnitQuantity
                      ├── UnitPrice
                      ├── CountryOfManufacture
                      ├── Harmonizedcode
                      ├── SalesTaxAmount
                      ├── DutyAmount
                      ├── Currency
                      ├── OutputCurrency
                      └── Amount

Response Layout

AbolSimpleShipmentResponse
  └── AbolSimpleShipmentResponse
      └── SimpleShipmentResult
          ├── Version
          ├── Error
          │   ├── Code
          │   └── Message
          └── SimpleShipment
              ├── DASFlag
              ├── RemoteAreaFlag
              ├── HandlingFlag
              ├── FuelSurchargeFlag
              ├── SortCode1
              ├── SortCode2
              ├── SortCode3
              ├── SortCode4
              ├── CODFee
              ├── BillWeight
              ├── DimWeight
              ├── Charge
              ├── DCFee
              ├── FuelCharge
              ├── ResidentialFee
              ├── SaturdayPickupFee
              ├── DeliveryDutyPaidFee
              ├── NeutralDeliveryFee
              ├── RemoteAreaFee
              ├── SplitDutyFee
              ├── TenThirtyAMFee
              ├── HoldAtLocationFee
              ├── ServiceCode
              ├── InsuranceCharge
              ├── ServiceId
              ├── TrackingNbr
              ├── LabelList
              │   └── Label1
              └── Fees
                  └── Fee
                      ├── FeeDetail name="DC" charge=""
                      ├── FeeDetail name="SC" charge=""
                      ├── FeeDetail name="COD" charge=""
                      ├── FeeDetail name="INSURANCE" charge=""
                      ├── FeeDetail name="SATURDAYDELIVERY" charge=""
                      ├── FeeDetail name="SATURDAYPICKUP" charge=""
                      ├── FeeDetail name="FUELSURCHARGE" charge=""
                      ├── FeeDetail name="LARGEPACKAGESURCHARGE" charge=""
                      └── FeeDetail name="ADDITIONALHANDLINGSURCHARGE" charge=""

Example Request

The request below is for processing a single piece shipment through the Yodel carrier.

<?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>
    <AbolSimpleShipment xmlns="http://abolsoft.com/webservices/">
      <AbolSimpleShipment>
        <AbolSimpleShip>
          <Request>
            <Authentication>
              <ActivationKey>JS03122010-5DF7A827-C833-4999-AD9D-0021CACC8445</ActivationKey>
              <LoginName>shipper</LoginName>
              <Password>shipper</Password>
            </Authentication>
            <SimpleShipment>
              <BillType>102</BillType>
              <DriverInstructions>Driver Instructions</DriverInstructions>
              <ResidentialFlag>false</ResidentialFlag>
              <SaturdayDeliveryFlag>false</SaturdayDeliveryFlag>
              <SaturdayPickupFlag>false</SaturdayPickupFlag>
              <LabelType>6</LabelType>
              <LabelSize>0</LabelSize>
              <HolidayDeliveryFlag>false</HolidayDeliveryFlag>
              <SundayDeliveryFlag>false</SundayDeliveryFlag>
              <DimensionUnit>IN</DimensionUnit>
              <WeightUnit>KG</WeightUnit>
              <ShipDate>2013-07-29T00:00:00-04:00</ShipDate>
              <ServiceCode>3693</ServiceCode>
              <DeclaredValue>100.55555555</DeclaredValue>
              <CurrencyCode>USD</CurrencyCode>
              <DimWeight>0</DimWeight>
              <TrackingNumber>ReferenceNbr_0729</TrackingNumber>
              <Length>5</Length>
              <Height>6</Height>
              <Width>7</Width>
              <PackagingType>105</PackagingType>
              <ReferenceNumber>ReferenceNbr_0729</ReferenceNumber>
              <Weight>10.111111111111111</Weight>
              <AddlPackageReference1>AdditionalPackageReference1</AddlPackageReference1>
              <AddlPackageReference2>AdditionalPackageReference2</AddlPackageReference2>
              <AddlPackageReference3>AdditionalPackageReference3</AddlPackageReference3>
              <AddlPackageReference4>AdditionalPackageReference4</AddlPackageReference4>
              <AddlPackageReference5>AdditionalPackageReference5</AddlPackageReference5>
              <AddlPackageReference6>AdditionalPackageReference6</AddlPackageReference6>
              <AddlPackageReference7>AdditionalPackageReference7</AddlPackageReference7>
              <AddlPackageReference8>AdditionalPackageReference8</AddlPackageReference8>
              <ContentDescription>ContentDescription</ContentDescription>
              <NotificationType>0</NotificationType>
              <ImageRotation>0</ImageRotation>
              <EveningDeliveryFlag>false</EveningDeliveryFlag>
              <ReturnType>0</ReturnType>
              <DeliveryConfirmationFlag>false</DeliveryConfirmationFlag>
              <SignatureConfirmationFlag>false</SignatureConfirmationFlag>
              <SignatureConfirmationType>100</SignatureConfirmationType>
              <InsuranceAmount>0</InsuranceAmount>
              <InsurancePayType>0</InsurancePayType>
              <InsuranceType>0</InsuranceType>
              <EndorsementType>0</EndorsementType>
              <OverrideShipToAddressValidationFlag>false</OverrideShipToAddressValidationFlag>
              <ShipTo>
                <Company>Company</Company>
                <Attn>Attn</Attn>
                <AddressLine1>146 Praed St</AddressLine1>
                <AddressLine2>Suite 100</AddressLine2>
                <AddressLine3>Adressline3</AddressLine3>
                <City>London</City>
                <Zip>W2 1EE</Zip>
                <CountryCode>GB</CountryCode>
                <Phone>6784943172</Phone>
                <PhoneExt>125</PhoneExt>
                <EMail>email@abolsoftware.com</EMail>
                <ResidentialFlag>false</ResidentialFlag>
                <IsPOBox>false</IsPOBox>
              </ShipTo>
              <Return>
                <Company>Abol SOftware</Company>
                <Attn>Shipping</Attn>
                <AddressLine1>413 Creekstone Ridge</AddressLine1>
                <City>Woodstock</City>
                <StateCode>GA</StateCode>
                <Zip>30188</Zip>
                <CountryCode>US</CountryCode>
                <ResidentialFlag>false</ResidentialFlag>
                <IsPOBox>false</IsPOBox>
              </Return>
              <SimpleExportLineItemList>
                <SimpleExportLineItem>
                  <Code>Code</Code>
                  <Description>Description</Description>
                  <Weight>1</Weight>
                  <UnitWeight>KG</UnitWeight>
                  <Price>2</Price>
                  <Quantity>1</Quantity>
                  <UnitQuantity>pcs</UnitQuantity>
                  <UnitPrice>2</UnitPrice>
                  <CountryOfManufacture>US</CountryOfManufacture>
                  <SalesTaxAmount>0</SalesTaxAmount>
                  <DutyAmount>0</DutyAmount>
                  <Amount>0</Amount>
                </SimpleExportLineItem>
              </SimpleExportLineItemList>
              <SimpleInternationalShipment>
                <DeclaredValue>0</DeclaredValue>
                <CN22DescriptionType>100</CN22DescriptionType>
                <ExportReasonCode>0</ExportReasonCode>
                <SEDFilingOption>0</SEDFilingOption>
                <FormGenerationType>0</FormGenerationType>
                <ExportType>0</ExportType>
                <ExceptionCode>0</ExceptionCode>
                <CustomFormType>0</CustomFormType>
                <DutyBillType>0</DutyBillType>
                <DutyServiceType>0</DutyServiceType>
                <IncludeDutyCalculation>false</IncludeDutyCalculation>
                <CommercialImporterFlag>false</CommercialImporterFlag>
                <TotalMonthlyImportedWeight>0</TotalMonthlyImportedWeight>
                <TotalMonthlyImportedValue>0</TotalMonthlyImportedValue>
              </SimpleInternationalShipment>
            </SimpleShipment>
          </Request>
        </AbolSimpleShip>
      </AbolSimpleShipment>
    </AbolSimpleShipment>
  </soap:Body>
</soap:Envelope>

Example Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <AbolSimpleShipmentResponse xmlns="http://abolsoft.com/webservices/">
      <AbolSimpleShipmentResponse>
        <SimpleShipmentResult>
          <Error>
            <Code>0</Code>
            <Message>Success</Message>
          </Error>
          <SimpleShipment>
            <DASFlag>false</DASFlag>
            <RemoteAreaFlag>false</RemoteAreaFlag>
            <HandlingFlag>false</HandlingFlag>
            <FuelSurchargeFlag>false</FuelSurchargeFlag>
            <SortCode1>HATFIELD</SortCode1>
            <SortCode2>VAUXHALL C</SortCode2>
            <SortCode3>078006</SortCode3>
            <SortCode4>077115</SortCode4>
            <CODFee>0</CODFee>
            <BillWeight>0</BillWeight>
            <DimWeight>0</DimWeight>
            <Charge>0</Charge>
            <DCFee>0</DCFee>
            <FuelCharge>0</FuelCharge>
            <ResidentialFee>0</ResidentialFee>
            <SaturdayPickupFee>0</SaturdayPickupFee>
            <DeliveryDutyPaidFee>0</DeliveryDutyPaidFee>
            <NeutralDeliveryFee>0</NeutralDeliveryFee>
            <RemoteAreaFee>0</RemoteAreaFee>
            <SplitDutyFee>0</SplitDutyFee>
            <TenThirtyAMFee>0</TenThirtyAMFee>
            <HoldAtLocationFee>0</HoldAtLocationFee>
            <ServiceCode>3693</ServiceCode>
            <InsuranceCharge>0</InsuranceCharge>
            <ServiceId>0</ServiceId>
            <TrackingNbr>JJD000223400118611</TrackingNbr>
            <Fees>
              <Fee>
                <FeeDetail name="DC" charge="0" />
                <FeeDetail name="SC" charge="0" />
                <FeeDetail name="COD" charge="0" />
                <FeeDetail name="INSURANCE" charge="0" />
                <FeeDetail name="SATURDAYDELIVERY" charge="0" />
                <FeeDetail name="SATURDAYPICKUP" charge="0" />
                <FeeDetail name="FUELSURCHARGE" charge="0" />
                <FeeDetail name="LARGEPACKAGESURCHARGE" charge="0" />
                <FeeDetail name="ADDITIONALHANDLINGSURCHARGE" charge="0" />
              </Fee>
            </Fees>
            <LabelList>
              <Label1>Removed from the response</Label1>
            </LabelList>
          </SimpleShipment>
          <Version>3.5.286.17470</Version>
        </SimpleShipmentResult>
      </AbolSimpleShipmentResponse>
    </AbolSimpleShipmentResponse>
  </soap:Body>
</soap:Envelope>
Back to top