# Shipments

# Shipments

## <span style="color: rgb(245, 89, 64);">**Overview**</span>

The Shipments page provides a centralised view of your shipment data, offering crucial details like courier service, request date, and reference. <span data-preserver-spaces="true">You can delve deeper into API request records and parcel tracking information, with options to cancel shipments, view and print labels, and access product specifics. Custom views introduce additional columns tailored to your preferences for added customisation, enhancing your overall shipment management experience.</span>

### <span style="color: rgb(245, 89, 64);">**Accessing the Shipments Page**</span>

Click the "Shipments" button in the left-hand menu to access it.

<video controls="controls" height="478" src="https://shipping-documentation.despatchcloud.app/attachments/224?open=true" style="width: 850px; height: 478px;" width="850"></video>

<p class="callout info">**Click to Play or Pause the Video**</p>

### <span style="color: rgb(245, 89, 64);">**Selecting Views**</span>

<span data-preserver-spaces="true">It's important to emphasise that you have complete control over the content and layout of the Shipments page, allowing you to tailor it to your preferences. To select your preferred display, click on the highlighted circular button in the page's upper-right corner.</span>

<span data-preserver-spaces="true">You have the flexibility to choose from three distinct views, allowing you to customise the columns and filters visible to you:</span>

- **<span data-preserver-spaces="true">Standard View</span>**<span data-preserver-spaces="true">: This is the recommended default view, ideal for users who wish to focus on essential information for efficient shipment tracking.</span>
- **<span data-preserver-spaces="true">Advanced View</span>**<span data-preserver-spaces="true">: The advanced view is tailored for developers and those who require in-depth access to shipments' request and response details.</span>
- **<span data-preserver-spaces="true">Custom View</span>**<span data-preserver-spaces="true">: With the custom view, you can craft a personalised display by selecting specific options. You can choose which columns to display using the "Column Selector" and determine which filters are visible in the "Filter Selector" section according to your preferences.</span>

<video controls="controls" height="476" src="https://shipping-documentation.despatchcloud.app/attachments/225?open=true" style="width: 846px; height: 476px;" width="846"></video>

<p class="callout info">**Click to Play or Pause the Video**</p>

### <span style="color: rgb(245, 89, 64);">**Searching and Filtering**</span>

<span data-preserver-spaces="true">On the right side of the search bar, you can search through your shipments using three distinct search parameters; here's a breakdown of these parameters:</span>

- **<span data-preserver-spaces="true">DC\_REQUEST\_ID</span>**<span data-preserver-spaces="true">: This unique reference we generated allows you to identify and reference individual shipments. In the shipment list, it appears as 'ID.'</span>
- **<span data-preserver-spaces="true">REFERENCE</span>**<span data-preserver-spaces="true">: The customer sets this field when creating a shipment request. Customers have the flexibility to define this reference as needed, though we recommend avoiding duplicates to ensure clarity.</span>
- **<span data-preserver-spaces="true">TRACKING\_CODE</span>**<span data-preserver-spaces="true">: This corresponds to the courier's tracking code, which can be used to trace shipments.</span>

<span data-preserver-spaces="true">Additionally, you'll find the date picker on the far right side of the search bar. This feature enables you to specify the date range for your search. To adjust the date range, click on the calendar icon. You have three options:</span>

- **<span data-preserver-spaces="true">Manual Date Range</span>**<span data-preserver-spaces="true">: You can select a date range from the calendar.</span>
- **<span data-preserver-spaces="true">Fast Date Picker</span>**<span data-preserver-spaces="true">: This convenient feature offers preset date range options commonly used, such as "This Week," "Last Week," "Month," and more. </span>
- **<span data-preserver-spaces="true">Time Picker:</span>**<span data-preserver-spaces="true"> If needed, you can even narrow your search to a specific hour.</span>

<span data-preserver-spaces="true">You'll find the filters section below the search bar, a powerful tool for refining your shipment search. The filters available will vary depending on the chosen view. Here's a comprehensive overview of these filter parameters:</span>

- **<span data-preserver-spaces="true">Couriers</span>**<span data-preserver-spaces="true">: This option allows you to select specific courier services for your scrutiny.</span>
- **<span data-preserver-spaces="true">Friendly Service Name</span>**<span data-preserver-spaces="true">: Utilise this filter to search for shipments associated with a particular courier preset. You can input either the Service ID or the name of the preset. For example, you can enter "IPX-DPDND" as the Service ID or "DPD Parcel Next Day." For a deeper understanding of courier services and presets, refer to the "How to Add a Courier Service" document.</span>
- **<span data-preserver-spaces="true">To Name</span>**<span data-preserver-spaces="true">: Use this filter to locate parcels sent to a specific recipient by entering their name.</span>
- **<span data-preserver-spaces="true">To Company</span>**<span data-preserver-spaces="true">: Enter the company name to identify shipments sent to a particular company. It corresponds to the "company\_name" in label requests as the shipment's contact details.</span>
- **<span data-preserver-spaces="true">To Postcode</span>**<span data-preserver-spaces="true">: Locate parcels delivered to a specific postcode by entering the postcode.</span>
- **<span data-preserver-spaces="true">To Country</span>**<span data-preserver-spaces="true">: Select the desired country or countries to narrow shipments to a specific destination.</span>
- **<span data-preserver-spaces="true">API Group &amp; Account</span>**<span data-preserver-spaces="true">: This filter is relevant for retailers or individual API users with only one API Account. However, resellers or agencies managing Voila for multiple customers may have multiple API user accounts (configurable in the "API Accounts" page). Use this filter to choose the API account or accounts you wish to examine.</span>
- **<span data-preserver-spaces="true">Account Name &amp; Number</span>**<span data-preserver-spaces="true">: For courier resellers, customers are assigned "Account Name" and "Account Number" values when setting up their accounts. These values are defined if a request originates from a customer's customer. In such cases, select a specific "Account Name" or "Number" to review shipments related to that account exclusively.</span>
- **<span data-preserver-spaces="true">Response Result</span>**<span data-preserver-spaces="true">: You can filter shipments based on whether they have succeeded or failed.</span>
- **<span data-preserver-spaces="true">Tracking</span>**<span data-preserver-spaces="true">: Use the Tracking filter to refine shipments by specific statuses, such as "Booked," "Collected," "Delivered," and more.</span>
- **<span data-preserver-spaces="true">On-Time/Late</span>**<span data-preserver-spaces="true">: To focus solely on shipments with specific time-related statuses like "Expected Late," "Expected On Time," "Delivered Late," or "Delivered On Time," make your selection here.</span>
- **<span data-preserver-spaces="true">Cancelled</span>**<span data-preserver-spaces="true">: Voila offers the capability to cancel labels sent (details on cancelling labels are provided later in this document). This filter lets you view shipments that have been cancelled or are still active by choosing "Yes" or "No."</span>
- **<span data-preserver-spaces="true">Archive</span>**<span data-preserver-spaces="true">: This filter exclusively displays archived and inactive shipments. You can choose between the "Yes" or "No" options.</span>

<video controls="controls" height="424" src="https://shipping-documentation.despatchcloud.app/attachments/246?open=true" style="width: 886px; height: 497px;" width="754"></video>

<p class="callout info">**Click to Play or Pause the Video**</p>

### <span style="color: rgb(245, 89, 64);">**Shipment Details**</span>

<span data-preserver-spaces="true">You'll find a comprehensive display of shipment details on the Shipments page. Let's take a closer look at the information presented, moving from left to right:</span>

- **<span data-preserver-spaces="true">Courier Service</span>**<span data-preserver-spaces="true">: This column provides information about the courier service used for each shipment.</span>
- **<span data-preserver-spaces="true">Request Date</span>**<span data-preserver-spaces="true">: Displays the date when the shipment request was made.</span>
- **<span data-preserver-spaces="true">Reference</span>**<span data-preserver-spaces="true">: This field contains the reference associated with each shipment provided by the customer during the shipment request.</span>
- **<span data-preserver-spaces="true">Response Result</span>**<span data-preserver-spaces="true">: If you click the "See Requests" button, you will be directed to the "API Request Records" page, offering a comprehensive view of all information related to this request.</span>
- **<span data-preserver-spaces="true">Tracking Section</span>**<span data-preserver-spaces="true">: This section provides tracking information for each parcel sent via a tracked service. Clicking "See History" opens a window with detailed tracking information, including:</span>
    - **<span data-preserver-spaces="true">Shipment</span>**<span data-preserver-spaces="true">: The customer's reference for the shipment.</span>
    - **<span data-preserver-spaces="true">Tracking Code</span>**<span data-preserver-spaces="true">: The unique code provided by the courier for tracking purposes.</span>
    - **<span data-preserver-spaces="true">On-Time Status</span>**<span data-preserver-spaces="true">: Indicates whether the shipment is expected to be on time or late.</span>
- **<span data-preserver-spaces="true">Tracking Status</span>**<span data-preserver-spaces="true">: Depending on the courier and parcel status, you may encounter various statuses, including:</span>
    - <span data-preserver-spaces="true">Booked</span>
    - <span data-preserver-spaces="true">Collected</span>
    - <span data-preserver-spaces="true">At Hub</span>
    - <span data-preserver-spaces="true">In Transit</span>
    - <span data-preserver-spaces="true">Out for Delivery</span>
    - <span data-preserver-spaces="true">Failed Attempt</span>
    - <span data-preserver-spaces="true">Delivered</span>
    - <span data-preserver-spaces="true">On Hold</span>
    - <span data-preserver-spaces="true">Address Issue</span>
    - <span data-preserver-spaces="true">Returned to Sender</span>
    - <span data-preserver-spaces="true">Tracking Expired</span>
    - <span data-preserver-spaces="true">Cancelled</span>
    - <span data-preserver-spaces="true">Awaiting Customer Collection</span>
    - <span data-preserver-spaces="true">Authentication Failed</span>
    - <span data-preserver-spaces="true">Please note that not all couriers support all these statuses, and some may not provide tracking updates. However, all couriers typically support the "Booked" and "Delivered" statuses.</span>
- **<span data-preserver-spaces="true">Cancel</span>**<span data-preserver-spaces="true">: Allows you to initiate the cancellation of a shipment, with the cancellation request forwarded to the courier.</span>
- **<span data-preserver-spaces="true">Label</span>**<span data-preserver-spaces="true">: Clicking this option redirects you to a new tab where you can view and print the shipment label.</span>
- **<span data-preserver-spaces="true">Info</span>**<span data-preserver-spaces="true">: Provides detailed information about the label, including product dimensions (Width, Length, Height, and Weight in metric units), SKUs contained within the shipment, and the Tracking Code.</span>
- **<span data-preserver-spaces="true">Custom View</span>**<span data-preserver-spaces="true">: </span><span data-preserver-spaces="true">If you opt for a custom view, additional columns become visible, such as "To Name," "To Company," "To Postcode," "To Country," "Reference," and "API Account" (also "Account Name" and "Account Number" if selected). These columns correspond to the filters discussed in this document's "Filters" section, offering further customisation options.</span>

<video controls="controls" height="508" src="https://shipping-documentation.despatchcloud.app/attachments/227?open=true" style="width: 905px; height: 508px;" width="905"></video>

<p class="callout info">**Click to Play or Pause the Video**</p>

### <span style="color: rgb(245, 89, 64);">**Downloading CSV**</span>

To obtain a report of your shipments, click the "Download CSV" button in the top right corner, as illustrated below. An Excel-format file will be generated for you, and within moments, it will initiate the download process. Please note that the download duration may vary depending on the selected data size, so it might take a while, as indicated in the image below. Once the file is ready, it will be delivered to your email address, allowing you to access and download it.

<video controls="controls" height="516" src="https://shipping-documentation.despatchcloud.app/attachments/228?open=true" style="width: 877px; height: 516px;" width="877"></video>

<p class="callout info">**Click to Play or Pause the Video**</p>

### <span style="color: rgb(245, 89, 64);">**Creating a Shipment**</span>

<span data-preserver-spaces="true">To begin the process of creating a shipment, follow these steps:</span>

1. <span data-preserver-spaces="true">Click the "Create Shipment" button in the top left corner of the page.</span>
2. <span data-preserver-spaces="true">You will be prompted to do so if this is the first time you have created a sender address. Click the "Add Address" button to proceed.</span>
3. <span data-preserver-spaces="true">Fill in the "Sender" address as explained below and click "Add Address" to continue. You can edit this address later using the "</span>[<span data-preserver-spaces="true">My Account</span>](https://shipping-documentation.despatchcloud.app/books/my-account/page/my-account)<span data-preserver-spaces="true">" page:</span>
    - **<span data-preserver-spaces="true">Address Name</span>**<span data-preserver-spaces="true">: Give a name to your address for easy recognition later.</span>
    - **<span data-preserver-spaces="true">First Name</span>**<span data-preserver-spaces="true">: Enter the sender's first name.</span>
    - **<span data-preserver-spaces="true">Last Name</span>**<span data-preserver-spaces="true">: Enter the sender's last name.</span>
    - **<span data-preserver-spaces="true">Email</span>**<span data-preserver-spaces="true">: Enter the sender's email address for contact purposes.</span>
    - **<span data-preserver-spaces="true">Phone</span>**<span data-preserver-spaces="true">: Enter the sender's phone number for any necessary communications.</span>
    - **<span data-preserver-spaces="true">Address Lookup</span>**<span data-preserver-spaces="true">: Use this feature to search for your address using a name or postcode. Click "Search" and select your address from the options provided. </span><span data-preserver-spaces="true">This</span><span data-preserver-spaces="true"> helps quickly fill in the address details.</span>
    - **<span data-preserver-spaces="true">Company</span>**<span data-preserver-spaces="true">: Enter the name of the sender's company, if applicable.</span>
    - **<span data-preserver-spaces="true">Address Line 1</span>**<span data-preserver-spaces="true">: Enter the primary street address of the sender.</span>
    - **<span data-preserver-spaces="true">Address Line 2</span>**<span data-preserver-spaces="true">: Enter additional address information, such as a suite or apartment number, if necessary.</span>
    - **<span data-preserver-spaces="true">City</span>**<span data-preserver-spaces="true">: Enter the city where the sender is located.</span>
    - **<span data-preserver-spaces="true">County</span>**<span data-preserver-spaces="true">: Enter the county or region where the sender is located.</span>
    - **<span data-preserver-spaces="true">Postcode</span>**<span data-preserver-spaces="true">: Enter the postal code for the sender's address.</span>
    - **<span data-preserver-spaces="true">Country</span>**<span data-preserver-spaces="true">: Select the sender's country from the dropdown menu.</span>
    - **<span data-preserver-spaces="true">Company ID</span>**<span data-preserver-spaces="true">: Enter the identification number assigned to your company for business identification purposes.</span>
    - **<span data-preserver-spaces="true">Tax ID</span>**<span data-preserver-spaces="true">: Enter the tax identification number </span><span data-preserver-spaces="true">used</span><span data-preserver-spaces="true"> for tax reporting and compliance.</span>
    - **<span data-preserver-spaces="true">IOSS Number</span>**<span data-preserver-spaces="true">: Enter the Import One-Stop Shop (IOSS) number, simplifying VAT payment for goods sold to EU customers.</span>
    - **<span data-preserver-spaces="true">EORI ID</span>**<span data-preserver-spaces="true">: Enter the Economic Operators Registration and Identification (EORI) number, which is required for customs declarations in the EU.</span>
    - **<span data-preserver-spaces="true">XI EORI</span>**<span data-preserver-spaces="true">: Enter the XI EORI number if applicable. </span><span data-preserver-spaces="true">This</span><span data-preserver-spaces="true"> is used for trade between Northern Ireland and non-EU countries.</span>
    - **<span data-preserver-spaces="true">EU EORI</span>**<span data-preserver-spaces="true">: Enter the EU EORI number if applicable. </span><span data-preserver-spaces="true">This</span><span data-preserver-spaces="true"> is used for trade within the EU.</span>
4. <span data-preserver-spaces="true">On the "Shipment Details" page, select a saved "Sender" address from the top. Below that, manually fill in each shipment's "Recipient" address information. The fields are the same as on the previous page; refer to the earlier step for explanations.</span>
5. <span data-preserver-spaces="true">Enter the weight and dimensions of your parcel. If you have multiple parcels in a shipment, click the "+ Add Another Parcel" button in the bottom left corner to add more parcels. To add a product to the parcel, click the "Add Product" button below the parcel information and fill in the details. Set the currency of this transaction. Click "Continue to Next Step" once all information is entered. Field explanations for this section are provided below:</span>
    - **<span data-preserver-spaces="true">Parcel</span>**<span data-preserver-spaces="true">:</span>
        - **<span data-preserver-spaces="true">Weight (kg)</span>**<span data-preserver-spaces="true">: Enter the weight of the parcel in kilograms.</span>
        - **<span data-preserver-spaces="true">Length (cm)</span>**<span data-preserver-spaces="true">: Enter the length of the parcel in centimetres.</span>
        - **<span data-preserver-spaces="true">Width (cm)</span>**<span data-preserver-spaces="true">: Enter the width of the parcel in centimetres.</span>
        - **<span data-preserver-spaces="true">Height (cm)</span>**<span data-preserver-spaces="true">: Enter the height of the parcel in centimetres.</span>
        - **<span data-preserver-spaces="true">Action</span>**<span data-preserver-spaces="true">: Use the trash bin icon to delete this parcel if necessary.</span>
    - **<span data-preserver-spaces="true">Add Product</span>**<span data-preserver-spaces="true">:</span>
        - **<span data-preserver-spaces="true">Product Name</span>**<span data-preserver-spaces="true">: Enter the name of the product being shipped.</span>
        - **<span data-preserver-spaces="true">Qty</span>**<span data-preserver-spaces="true">: Enter the quantity of the product.</span>
        - **<span data-preserver-spaces="true">SKU</span>**<span data-preserver-spaces="true">: Enter the product's Stock Keeping Unit (SKU), which is used for inventory management.</span>
        - **<span data-preserver-spaces="true">Value (in your selected currency)</span>**<span data-preserver-spaces="true">: Enter the product's value in the currency used for customs declarations and insurance.</span>
        - **<span data-preserver-spaces="true">Weight (kg)</span>**<span data-preserver-spaces="true">: Enter the weight of the product in kilograms.</span>
        - **<span data-preserver-spaces="true">Action</span>**<span data-preserver-spaces="true">: Edit or delete the product details from the shipment if necessary.</span>
    - **<span data-preserver-spaces="true">Currency</span>**<span data-preserver-spaces="true">: Select the currency for the transaction. Supported currencies are GBP, USD, EUR, JPY, CAD, CHF, AUD, and CNH.</span>
6. <span data-preserver-spaces="true">On the "Presets" screen, choose from the "Rule Groups" you created earlier to get a Smart Shipping recommendation based on your rules. You can use the "Smart Shipment Recommendation" feature or select from the "Shipping Services" installed below. Click the "Create Shipment" button once all information below is entered:</span>
    - **<span data-preserver-spaces="true">Smart Shipping Feature</span>**<span data-preserver-spaces="true">: Learn more about setting up and using this feature on our dedicated documentation page </span>[<span data-preserver-spaces="true">here</span>](https://shipping-documentation.despatchcloud.app/books/getting-started-with-voila/page/standard-mode#bkmrk-creating-smart-rules-1)<span data-preserver-spaces="true">.</span>
    - **<span data-preserver-spaces="true">Shipping Services</span>**<span data-preserver-spaces="true">: </span>[<span data-preserver-spaces="true">This page</span>](https://shipping-documentation.despatchcloud.app/books/courier-directory/chapter/courier-setups)<span data-preserver-spaces="true"> provides details on installing a courier integration. After installing your shipping service, you can learn about installing a </span>[<span data-preserver-spaces="true">courier service here</span>](https://shipping-documentation.despatchcloud.app/books/courier-directory/page/how-to-add-a-courier-service)<span data-preserver-spaces="true">.</span>
    - **<span data-preserver-spaces="true">Print Documents</span>**<span data-preserver-spaces="true">: Select a label size from the dropdown. For the size information, see our "</span>[<span data-preserver-spaces="true">Label Sizes and Usage Guide</span>](https://shipping-documentation.despatchcloud.app/books/integration-information/page/how-to-change-label-sizes)<span data-preserver-spaces="true">".</span>
    - **<span data-preserver-spaces="true">Reference ID</span>**<span data-preserver-spaces="true">: Set a manual reference ID for this shipment to help you track and identify the shipment later.</span>
    - **<span data-preserver-spaces="true">Collection Date</span>**<span data-preserver-spaces="true">: Use the date picker to select a collection date for this shipment. </span><span data-preserver-spaces="true">This</span><span data-preserver-spaces="true"> is the date on which the shipment will be picked up.</span>
    - **<span data-preserver-spaces="true">Add Delivery Instructions</span>**<span data-preserver-spaces="true">: Add additional notes to the label, such as special delivery instructions for the courier.</span>
7. <span data-preserver-spaces="true">Your shipment is created. Use the "Print Label" button to display and print the label, ensure you have entered all the correct information; the system will keep checking to ensure until everything is correct. </span>
8. <span data-preserver-spaces="true">Clicking the previous button will open a new tab in your browser, displaying the label in PDF format. You can print it from there.</span>

<video controls="controls" height="496" src="https://shipping-documentation.despatchcloud.app/attachments/229?open=true" style="width: 882px; height: 496px;" width="882"></video>

<p class="callout info">**Click to Play or Pause the Video**</p>