About this guide

Shipping verification workflows

Creating beverage alcohol transactions in AvaTax

Shipping verification endpoints

Age verification endpoints

Examples

FAQs

SHIPPING AND AGE VERIFICATION FOR BEVERAGE ALCOHOL

<div class="layout-wrap__column                                                                                                                        null                                                                                                                                                                        ">                                                <div class="layout-wrap__content">                                        <div class="sectiontitle parbase"><div class="section-title">    <h1 class=" h1 ava-gray-darkest text-left d-flex flex-column" style="padding-top: 0px; padding-bottom: 0px;">          <span class="position-relative">              Compliant purchase                        </span>                          </h1></div></div>            <div class="richtext parbase">										 <p>This example show a compliant beverage alcohol sales invoice transaction. In this example:</p><ul><li>A valid license exists for shipping to Kentucky.</li><li>The<code >taxCode</code> is a valid code for compliance verification:<code >PA2020100</code>.</li><li>The<code >routeType</code> is a valid type for compliance verification:<code >DTC</code>.</li><li>The quantity of alcohol being purchased is within the legal limit.</li><li>The purchaser is at least 21 years old.</li><li>The recipient is at least 21 years old.</li></ul>	</div>            <div class="sectiontitle parbase"><div class="section-title">    <h3 class=" h3 ava-gray-darkest text-left d-flex flex-column" style="padding-top: 0px; padding-bottom: 0px;" id="verifyresponse">          <span class="position-relative">              Transaction request                        </span>                          </h3></div></div>            <div class="richtext parbase">										 <p>The following transaction shows a request for purchasing both packaged alcohol spirits and wine glasses.</p>	</div>            <div class="codesnippet"><pre><code class="hljs">curl<br>    -X POST<br>    -H 'Accept: application/json'<br>    -H 'Authorization: Basic aHR0cHdhdQNoOmY='<br>    -H 'Content-Type: application/json'<br>    --data '{<br>      "type":"SalesInvoice",<br>      "code": "CompliantPurchase",<br>      "companyCode":"DEFAULT",<br>      "customerCode":"13434",<br>      "date":"2022-08-15",<br>      "commit":true,<br>      "lines": [<br>        {<br>          "number":"1",<br>          "quantity":3,<br>          "amount":100,<br>          "taxCode":"PA2020100",<br>          "itemCode":"12345",<br>          "description":"Packaged alcohol spirits",<br>          "parameters":[<br>              {<br>                  "name":"AlcoholRouteType",<br>                  "value":"DTC"<br>              },<br>              {<br>                  "name":"RecipientName",<br>                  "value":"John Smith"<br>              },<br>              {<br>                  "name":"PurchaserDOB",<br>                  "value":"1995-03-29"<br>              },<br>              {<br>                  "name":"RecipientDOB",<br>                  "value":"2000-01-02"<br>              },<br>              {<br>                  "name":"ContainerSize",<br>                  "value":"750",<br>                  "unit":"Millilitre"<br>              },<br>              {<br>                  "name":"AlcoholContent",<br>                  "value":"80",<br>                  "unit":"Percentage"<br>              },<br>              {<br>                  "name":"PackSize",<br>                  "value":"1",<br>                  "unit":"Count"<br>              },<br>              {<br>                  "name":"NetVolume",<br>                  "value":"750",<br>                  "unit":"Millilitre"<br>              },<br>              {<br>                  "name":"Brand",<br>                  "value":"Premier"<br>              },<br>              {<br>                  "name":"CarrierCode",<br>                  "value":"UPS"<br>              },<br>              {<br>                  "name":"IsAlcoholSample",<br>                  "value":false<br>              },<br>              {<br>                  "name":"IsDirectAlcoholImport",<br>                  "value":false<br>              },<br>              {<br>                  "name":"IsForeignAlcohol",<br>                  "value":false<br>              },<br>              {<br>                  "name":"SalesLocation",<br>                  "value":"offsite"<br>              },<br>              {<br>                  "name":"SellerClassification",<br>                  "value":"OutOfStateDirectShipper"<br>              },<br>              {<br>                  "name":"ShipDate",<br>                  "value":"2022-08-16"<br>              },<br>              {<br>                  "name":"TrackingNumber",<br>                  "value":"1Z654321MB12345678"<br>              }<br>          ]<br>        }, <br>        {<br>          "number":"2",<br>          "quantity":1,<br>          "amount":10,<br>          "taxCode":"PG068810",<br>          "itemCode":"12348",<br>          "description":"Cabernet wine glasses"<br>        }<br>      ],<br>      "addresses": {<br>        "shipFrom":{<br>          "line1":"255 S King St",<br>          "line2":"Suite 1200",<br>          "city":"Seattle",<br>          "region":"WA",<br>          "country":"US",<br>          "postalCode":"98104"<br>        },<br>        "shipTo":{<br>          "line1":"2100 S Floyd St",<br>          "city":"Louisville",<br>          "region":"KY",<br>          "country":"US",<br>          "postalCode":"40292"<br>        }<br>      }<br>    }'<br>    'https://sandbox-rest.avatax.com/api/v2/transactions/create'</code></pre></div>            <div class="sectiontitle parbase"><div class="section-title">    <h3 class=" h3 ava-gray-darkest text-left d-flex flex-column" style="padding-top: 0px; padding-bottom: 0px;">          <span class="position-relative">              Verification request                        </span>                          </h3></div></div>            <div class="richtext parbase">										 <p>In the verification request, be sure to include your<code >companyCode</code> and the transaction<code >code</code>. In the transaction above, the<code >companyCode</code> is<code >DEFAULT</code>, and the transaction<code >code</code> is<code >CompliantPurchase</code>.</p>	</div>            <div class="codesnippet"><pre><code class="hljs">curl<br>    -X GET<br>    -H 'Accept: application/json'<br>    -H 'Authorization: Basic aHR0cHdhdQNoOmY='<br>    -H 'Content-Type: application/json'<br>    'https://sandbox-rest.avatax.com/api/v2/companies/DEFAULT/transactions/CompliantPurchase/shipment/verify'</code></pre></div>            <div class="sectiontitle parbase"><div class="section-title">    <h3 class=" h3 ava-gray-darkest text-left d-flex flex-column" style="padding-top: 0px; padding-bottom: 0px;">          <span class="position-relative">              Response                        </span>                          </h3></div></div>            <div class="richtext parbase">										 <p>The response returns<code >"compliant": true</code>. In addition, the<code >successMessages</code> for line 1 describes how each check in the transaction passed compliance verification. Also notice that the message for line 2 indicates that the line references an unsupported tax code. This message is deliberate and simply means that a compliance check was not performed on that line because only supported beverage alcohol tax codes are verified.</p>	</div>            <div class="codesnippet"><pre><code class="hljs">{<br>  "compliant": true,<br>  "warningCodes": [<br>    "UnsupportedTaxCode"<br>  ],<br>  "message": "Transaction is compliant",<br>  "successMessages": "Line \"1\": The recipient is older than 21 years of age; The purchaser is older than 21 years of age; The Per Individual volume limit in KENTUCKY is 10 Litre(s) (10000 Millilitre(s)) per 1 month. Including registered shipments, 2.25 Litre(s) (2250 Millilitre(s)) would be shipped to this Individual in a 1 month timeframe. Therefore, the volume in this transaction is under the volume limit.\n",<br>  "failureMessages": "",<br>  "failureCodes": [],<br>  "lines": [<br>    {<br>      "resultCode": "Compliant",<br>      "lineNumber": "1",<br>      "message": "Line is compliant",<br>      "successMessages": "The recipient is older than 21 years of age; The purchaser is older than 21 years of age; The Per Individual volume limit in KENTUCKY is 10 Litre(s) (10000 Millilitre(s)) per 1 month. Including registered shipments, 2.25 Litre(s) (2250 Millilitre(s)) would be shipped to this Individual in a 1 month timeframe. Therefore, the volume in this transaction is under the volume limit.",<br>      "failureMessages": "",<br>      "failureCodes": []<br>    },<br>    {<br>      "resultCode": "UnsupportedTaxCode",<br>      "lineNumber": "2",<br>      "message": "Line refers to an unsupported tax code",<br>      "successMessages": "",<br>      "failureMessages": "",<br>      "failureCodes": []<br>    }<br>  ]<br>}</code></pre></div>            <div class="spacer parbase"><div class="row pt-8  "></div></div>            <div class="layout"><div class="layout-wrap                                         ">                <div class="container layout-wrap__inner ">        <div class="row justify-content-start ">                            <div class="top                        col-6                        col-md-6                        col-lg-6                                                 ">                                        <div class="layout-wrap__column                                                                                                                        null                                                                                                                                                                        ">                                                <div class="layout-wrap__content">                                        <div class="cta parbase"> <div class="justify-content-start clearfix row" activitymap.region="en_us:CTA">                                                    <a href="/companion/shipping-verification-bevalc/age-verification-endpoint" target="_self" class="avalara__btn__btn-primary btn-primary-css orange-theme  cta--one">                                                                                            Previous</a>            </div></div>                        </div>                    </div>                </div>                            <div class="top                        col-6                        col-md-6                        col-lg-6                                                 ">                                        <div class="layout-wrap__column                                                                                                                        null                                                                                                                                                                        ">                                                <div class="layout-wrap__content">                                        <div class="cta parbase"> <div class="justify-content-end clearfix row" activitymap.region="en_us:CTA">                                                    <a href="/companion/shipping-verification-bevalc/example-non-compliant" target="_self" class="avalara__btn__btn-primary btn-primary-css orange-theme  cta--one">                                                                                            Next</a>            </div></div>                        </div>                    </div>                </div>                    </div>    </div></div></div>            <div class="spacer parbase"><div class="row pt-10  "></div></div>                        </div>                    </div>