Carrier mapping

tax codes

The ‘Codes’ in the table below need to be used in the ‘Type’ element within the tax item collection and the value is just the tax value / code that we need to pass onto the carrier.

Currently, this is only available through an Omni Parcel carrier integration.

Data structure:

<TaxItems>

      <TaxItem>

         <Type>GBEORINumber</Type>

         <Value>12345678</Value>

      </TaxItem>

</TaxItems>

Example data within sales order message, highlighted in orange below:

<?xml version="1.0" encoding="UTF-8"?>

<Requests>

   <Request>

      <SalesOrder>

         <SalesOrderNumber>XMLSAMLPLE</SalesOrderNumber>

         <SalesOrderReference>XML SAMPLE</SalesOrderReference>

         <SalesOrderDate>2022-03-09T15:01:20</SalesOrderDate>

         <CourierName />

         <CourierService />

         <Notes />

         <OrderType>Standard</OrderType>

         <ShipmentTerms>DDP</ShipmentTerms>

      </SalesOrder>

      <ShipToCompany>

         <CompanyCode>COMPANYCODE</CompanyCode>

         <CompanyDescription>COMPANY</CompanyDescription>

      </ShipToCompany>

      <DeliveryDetails>

         <FirstName>First Name</FirstName>

         <LastName>Last Name</LastName>

         <Line1>Assos of switzerland gmbh</Line1>

         <Line2>Via Giuseppe corti 5</Line2>

         <Line3></Line3>

         <City>Balerna</City>

         <County />

         <PostcodeZip>6828</PostcodeZip>

         <CountryCode>CH</CountryCode>

         <PhoneNumber>12345678</PhoneNumber>

         <EmailAddress>email@email.com</EmailAddress>

      </DeliveryDetails>

      <BillingDetails>

         <FirstName>First Name</FirstName>

         <LastName>Last Name</LastName>

         <Line1>Assos of switzerland gmbh</Line1>

         <Line2>Via Giuseppe corti 5</Line2>

         <Line3 />

         <City>Balerna</City>

         <County />

         <PostcodeZip>6828</PostcodeZip>

         <CountryCode>CH</CountryCode>

         <PhoneNumber>12345678</PhoneNumber>

         <EmailAddress>email@email.com</EmailAddress>

      </BillingDetails>

      <SalesOrderHeader>

         <DCCode>DCCL01</DCCode>

      </SalesOrderHeader>

      <List>

         <SalesOrderLineItem>

            <LineNumber>1</LineNumber>

            <ProductCode>PROD1</ProductCode>

            <Quantity>2</Quantity>

            <UnitPrice>16.33</UnitPrice>

            <CurrencyCode>GBP</CurrencyCode>

         </SalesOrderLineItem>

         <SalesOrderLineItem>

            <LineNumber>2</LineNumber>

            <ProductCode>PROD2</ProductCode>

            <Quantity>2</Quantity>

            <UnitPrice>16.33</UnitPrice>

            <CurrencyCode>GBP</CurrencyCode>

         </SalesOrderLineItem>

      </List>

     <TaxItems>

      <TaxItem>

        <Type>SWISSVAT</Type>

         <Value>CHE-123.456.789</Value>

      </TaxItem>

   </TaxItems>

   </Request>

</Requests>