# Ship Logic Courier Delivery Setup and Usage

<span class="md-plain md-expand">To view instructions on creating a shipment from an Invoice without an overview of the relevant form components, click [here](https://hugeerp0.co.za/hsofdocs/link/129#bkmrk-creating-a-shipment). </span>

## <span class="md-plain md-expand">Set Up</span>

### <span class="md-plain md-expand">Ship Logic Account</span>

<span class="md-plain">From the Account Settings page in Ship Logic, click the Create API Key.</span>

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/3Ltimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/3Ltimage.png)

Copy the API Key to the clipboard and store it somewhere safe.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/DRLimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/DRLimage.png)

### API Setup

Return to Huge ERP and navigate to API Setup in the SCM module under Security.

Click the Add button in the top toolbar.

Select Ship Logic API from the API combo box in the Add form.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/3feimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/3feimage.png)

In the Location field enter "api.shiplogic.com" without the quotes.

In the User Name field enter the email address used to log into Ship Logic.

Copy the API Key copied from the Ship Logic Account Settings page to the API Key field.

In the config field enter "bearer" without the quotes.

Make sure the Active checkbox is checked.

Click Save when done.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Cn9image.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/Cn9image.png)

### Creating a Delivery Company

To select Ship Logic as the API for courier delivery for an Invoice or other applicable document, it first needs to be added as a Delivery Company in Creditors Setup in the Creditors Module under Configuration.

Click the Add button in the top toolbar.

In the Details tab fill in the Credit Code, Name and Short Name fields for the Delivery Company. Other information in this tab is optional.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/R2mimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/R2mimage.png)

Save the form by clicking the Save button, and then switch to the Info tab.

In the Use Courier API combo box select Ship Logic API, then save the form again. The form can now be closed.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/x8Uimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/x8Uimage.png)

### Shipping Terms

In addition to creating a Delivery Company for Ship Logic, Shipping Terms need to be created for selecting the Delivery Company from an Invoice form.

Navigate to Additional Debtor Properties in the Debtor module under Configuration. Switch to the Shipping Terms tab.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/AHiimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/AHiimage.png)

Click the Add button in the top toolbar.

In the Shipping Method form enter a Code and Description in the respective fields. Select Delivery for the Ship Type combo box and External for the Delivery By combo box.

The Delivery Company combo box should be enabled after selecting External for the Delivery By combo box. Select the created Delivery Company for the combo box.

Make sure the Active checkbox is checked, and then click Save &amp; Close.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/0aximage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/0aximage.png)

It should now be possible to create shipments with Ship Logic from Invoice forms.

### Optional - Service Types

Optionally Service Types can be created to populate the Service Type combo box in the Shipping tab of the Invoice form. To do this navigate to Courier Setup in the SCM module under Administration.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/4CFimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/4CFimage.png)

Service Types can be added, edited and deleted from this panel. The selected API should be Ship Logic API and the Code should be unique for Ship Logic. The codes should correspond to valid Service Type codes for Ship Logic. Service Types available for a delivery can be viewed as described by clicking the Courier API or Get Rates button in the Shipping tab of the Invoice form, as described in the next section.

### Optional - Predefined Parcel Sizes

Predefined parcel sizes can be created in the Courier Setup panel in the Parcel Sizes tab, or in the Defaults tab in the Parcel Selection grid, which is described in the next section. Predefined parcel sizes can be used as templates to create new parcel entries with the same values for a new shipment from the Parcel Selection for an Invoice. The selected API should be Ship Logic and the name should be unique. The dimensions and weight should all be provided.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Aadimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/Aadimage.png)

## <span class="md-plain">Using Ship Logic to Create Shipments</span>

<span class="md-plain">Shipments can be created from the document types:</span>

- <span class="md-plain">Invoice</span>
- <span class="md-plain">Sales Order</span>
- <span class="md-plain">Sales Order Confirm</span>
- <span class="md-plain">Dispatch Stock Documents </span>

<span class="md-plain">The process to create a shipment is identical for all document types, however the delivery status can only be updated automatically from Invoice documents at this point.</span>

<span class="md-plain">Outside of the document form, the Collection address is retrieved from the Company Profile Info form in SCM. Currently only the physical address fields are selected.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/RmDimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/RmDimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/RmDimage.png)</span>

#### <span class="md-plain">Address Fields</span>

<figure class="md-table-fig table-figure" id="bkmrk-field-description-ex"><table class="md-table"><thead><tr class="md-end-block"><th><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Field</span>**</span></span></th><th><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Description</span>**</span></span></th><th><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Example</span>**</span> </span></th></tr></thead><tbody><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Address Line 1</span></span></td><td><span class="td-span"><span class="md-plain">The street address</span></span></td><td><span class="td-span"><span class="md-plain">1188 Lois Avenue</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Address Line 2</span></span></td><td><span class="td-span"><span class="md-plain">The suburb, or local area</span></span></td><td><span class="td-span"><span class="md-plain">Menlyn</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Address Line 3</span></span></td><td><span class="td-span"><span class="md-plain">The city</span></span></td><td><span class="td-span"><span class="md-plain">Pretoria</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Address Line 4</span></span></td><td><span class="td-span"><span class="md-plain">The region or province</span></span></td><td><span class="td-span"><span class="md-plain">Gauteng</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Country</span></span></td><td><span class="td-span"><span class="md-plain">The selected country, defaults to South Africa</span></span></td><td><span class="td-span"><span class="md-plain">South Africa</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">GPS Coords</span></span></td><td><span class="td-span"><span class="md-plain">Optional GPS coordinates, comma separated latitude then longitude</span></span></td><td><span class="td-span"><span class="md-plain">-25.7863272, 28.334732</span></span></td></tr></tbody></table>

</figure>### <span class="md-plain">Creating Shipments from an Invoice</span>

<span class="md-plain">An Invoice to create a shipment from can be in Preparation or Posted Status. If in Posted status, only the fields in the Shipping tab can be edited. </span>

<span class="md-plain">At a minimum, outside of the Shipping tab fields, the Customer, Internal Contact and Contact Person fields are required.</span>

<span class="md-plain">Components and fields that may be used are marked red in the screenshots, and the fields that are not used are marked purple. Buttons that are optionally used are marked yellow. </span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/UC6image.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/UC6image.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/UC6image.png)</span>

#### <span class="md-plain">Detail Tab components</span>

<figure class="md-table-fig table-figure" id="bkmrk-component-used-requi"><table class="md-table" style="width: 100%;"><thead><tr class="md-end-block"><th style="width: 18.0425%;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Component</span>**</span></span></th><th style="width: 10.0099%;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Used</span>**</span></span></th><th style="width: 10.3812%;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Required</span>**</span></span></th><th style="width: 61.5417%;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Description</span>**</span></span></th></tr></thead><tbody><tr class="md-end-block"><td style="width: 18.0425%;"><span class="td-span"><span class="md-plain">Customer</span></span></td><td style="width: 10.0099%;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.3812%;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 61.5417%;"><span class="td-span"><span class="md-plain">Used for Delivery Address and Delivery Contact. Required to save a new Invoice. The delivery address used is the Customer address for the Address Type selected in the Shipping tab. The numbered address fields are required to be for the same address components as the Branch Address, e.g. Address Line 1 is for the Street Address. If a Contact Person is not selected from the Address tab then the Delivery Contact is obtained from the selected customer instead. The first name, last name, email and mobile number of is used, with the name and either the email or mobile number being required. </span></span></td></tr><tr class="md-end-block"><td style="width: 18.0425%;"><span class="td-span"><span class="md-plain">Sales Rep</span></span></td><td style="width: 10.0099%;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 10.3812%;"> </td><td style="width: 61.5417%;"> </td></tr><tr class="md-end-block"><td style="width: 18.0425%;"><span class="td-span"><span class="md-plain">Reference</span></span></td><td style="width: 10.0099%;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.3812%;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 61.5417%;"><span class="td-span"><span class="md-plain">Becomes the customer reference for the delivery if set</span></span></td></tr><tr class="md-end-block"><td style="width: 18.0425%;"><span class="td-span"><span class="md-plain">Internal Contact</span></span></td><td style="width: 10.0099%;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.3812%;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 61.5417%;"><span class="td-span"><span class="md-plain">Used for the Collection Address and Collection Contact. The collection address becomes the Physical Address of the Branch the user belongs to. The first and last name, and email and mobile number are used, with the email or mobile number being required as with the Delivery Contact.</span></span></td></tr></tbody></table>

</figure>#### <span class="md-plain">Address Tab components</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/q42image.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/q42image.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/q42image.png)</span>

<figure class="md-table-fig table-figure" id="bkmrk-component-used-requi-1"><table class="md-table" style="width: 100%; height: 337.4px;"><thead><tr class="md-end-block" style="height: 36.8px;"><th style="width: 15.6945%; height: 36.8px;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Component</span>**</span></span></th><th style="width: 7.29225%; height: 36.8px;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Used</span>**</span></span></th><th style="width: 9.51447%; height: 36.8px;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Required</span>**</span></span></th><th style="width: 67.474%; height: 36.8px;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Description</span>**</span></span></th></tr></thead><tbody><tr class="md-end-block" style="height: 36.2px;"><td style="width: 15.6945%; height: 36.2px;"><span class="td-span"><span class="md-plain">Address Type</span></span></td><td style="width: 7.29225%; height: 36.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 9.51447%; height: 36.2px;"> </td><td style="width: 67.474%; height: 36.2px;"><span class="td-span"><span class="md-plain">Address that when selected will populate the address fields in this tab.</span></span></td></tr><tr class="md-end-block" style="height: 63.2px;"><td style="width: 15.6945%; height: 63.2px;"><span class="td-span"><span class="md-plain">Address Fields</span></span></td><td style="width: 7.29225%; height: 63.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 9.51447%; height: 63.2px;"> </td><td style="width: 67.474%; height: 63.2px;"><span class="td-span"><span class="md-plain">Currently is not used. Instead the unedited customer address for the selected customer in the Detail Tab and address type in the Shipping Tab is used for the delivery address. </span></span></td></tr><tr class="md-end-block" style="height: 46.4px;"><td style="width: 15.6945%; height: 46.4px;"><span class="td-span"><span class="md-plain">Contact Person</span></span></td><td style="width: 7.29225%; height: 46.4px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 9.51447%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 67.474%; height: 46.4px;"><span class="td-span"><span class="md-plain">Overrides the default contact person for the Customer if selected. The name and email or mobile number of the Contact Person is required.</span></span></td></tr><tr class="md-end-block" style="height: 38px;"><td style="width: 15.6945%; height: 38px;"><span class="td-span"><span class="md-plain">View Button</span></span></td><td style="width: 7.29225%; height: 38px;"><span class="td-span"><span class="md-plain">N/A</span></span></td><td style="width: 9.51447%; height: 38px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 67.474%; height: 38px;"><span class="td-span"><span class="md-plain">Can be used to edit the details for the selected Contact Person.</span></span></td></tr><tr class="md-end-block" style="height: 46.4px;"><td style="width: 15.6945%; height: 46.4px;"><span class="td-span"><span class="md-plain">Contact No</span></span></td><td style="width: 7.29225%; height: 46.4px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 9.51447%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 67.474%; height: 46.4px;"><span class="td-span"><span class="md-plain">If set then this Contact Number is used instead of the Mobile Number for the selected Contact Person or default Debtor Contact Person.</span></span></td></tr><tr class="md-end-block" style="height: 36.2px;"><td style="width: 15.6945%; height: 36.2px;"><span class="td-span"><span class="md-plain">Region</span></span></td><td style="width: 7.29225%; height: 36.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 9.51447%; height: 36.2px;"> </td><td style="width: 67.474%; height: 36.2px;"><span class="td-span"><span class="md-plain">Is unrelated to the Region given in the addresses. </span></span></td></tr><tr class="md-end-block" style="height: 34.2px;"><td style="width: 15.6945%; height: 34.2px;"><span class="td-span"><span class="md-plain">Branch</span></span></td><td style="width: 7.29225%; height: 34.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 9.51447%; height: 34.2px;"> </td><td style="width: 67.474%; height: 34.2px;"><span class="td-span"><span class="md-plain">The branch address is from the branch the Internal Contact belongs to.</span></span></td></tr></tbody></table>

</figure>#### <span class="md-plain">Shipping Tab components</span>

<span class="md-plain">All of the components in the main area, that are not marked purple in the screenshot are required or are used for Courier Delivery related functions with Ship Logic. The components that are required to create a Shipment are marked red.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Iq2image.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Iq2image.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/Iq2image.png)</span>

<figure class="md-table-fig table-figure" id="bkmrk-component-used-requi-2"><table class="md-table" style="width: 100%; height: 1346px;"><thead><tr class="md-end-block" style="height: 63.2px;"><th style="width: 21.9947%; height: 63.2px;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Component</span>**</span></span></th><th style="width: 8.40568%; height: 63.2px;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Used</span>**</span></span></th><th style="width: 10.8749%; height: 63.2px;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Required</span>**</span></span></th><th style="width: 58.6999%; height: 63.2px;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Description</span>**</span></span></th></tr></thead><tbody><tr class="md-end-block" style="height: 88.4px;"><td style="width: 21.9947%; height: 88.4px;"><span class="td-span"><span class="md-plain">Shipping Terms</span></span></td><td style="width: 8.40568%; height: 88.4px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 88.4px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 58.6999%; height: 88.4px;"><span class="td-span"><span class="md-plain">Required to populate the Delivery Company combo box and then select the Courier Company for Ship Logic. For more information view the </span><span class="md-meta-i-c  md-link">[<span class="md-plain">Set Up section</span>](https://hugeerp0.co.za/hsofdocs/link/129#bkmrk-set-up)</span><span class="md-plain">. </span></span></td></tr><tr class="md-end-block" style="height: 46.4px;"><td style="width: 21.9947%; height: 46.4px;"><span class="td-span"><span class="md-plain">Collect / Ship Date</span></span></td><td style="width: 8.40568%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 10.8749%; height: 46.4px;"> </td><td style="width: 58.6999%; height: 46.4px;"><span class="td-span"><span class="md-plain">Currently not used for Ship Logic, but could be used to schedule the collection date and time. </span></span></td></tr><tr class="md-end-block" style="height: 63.2px;"><td style="width: 21.9947%; height: 63.2px;"><span class="td-span"><span class="md-plain">Shipping Options - email</span></span></td><td style="width: 8.40568%; height: 63.2px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 63.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 63.2px;"><span class="td-span"><span class="md-plain">If checked then delivery updates are sent to the Collection contact by email or SMS.</span></span></td></tr><tr class="md-end-block" style="height: 63.2px;"><td style="width: 21.9947%; height: 63.2px;"><span class="td-span"><span class="md-plain">Shipping Options - other</span></span></td><td style="width: 8.40568%; height: 63.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 10.8749%; height: 63.2px;"> </td><td style="width: 58.6999%; height: 63.2px;"><span class="td-span"><span class="md-plain">These shipping options do not apply to Ship Logic. <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span></span></td></tr><tr class="md-end-block" style="height: 46.4px;"><td style="width: 21.9947%; height: 46.4px;"><span class="td-span"><span class="md-plain">Pickup Instructions</span></span></td><td style="width: 8.40568%; height: 46.4px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 46.4px;"><span class="td-span"><span class="md-plain">Special instructions for the delivery driver when collecting the shipment. <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span></span></td></tr><tr class="md-end-block" style="height: 46.4px;"><td style="width: 21.9947%; height: 46.4px;"><span class="td-span"><span class="md-plain">Delivery Instructions</span></span></td><td style="width: 8.40568%; height: 46.4px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 46.4px;"><span class="td-span"><span class="md-plain">Special instructions for the delivery driver when delivering the shipment. <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span></span></td></tr><tr class="md-end-block" style="height: 52px;"><td style="width: 21.9947%; height: 52px;"><span class="td-span"><span class="md-plain">Delivery Company</span></span></td><td style="width: 8.40568%; height: 52px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 52px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 58.6999%; height: 52px;"><span class="td-span"><span class="md-plain">Required to select the Courier Company that has for its Courier API field Ship Logic set. For more information view the </span><span class="md-meta-i-c  md-link">[<span class="md-plain">Set Up section</span>](https://hugeerp0.co.za/hsofdocs/link/129#bkmrk-set-up)</span><span class="md-plain">. </span></span></td></tr><tr class="md-end-block" style="height: 46.4px;"><td style="width: 21.9947%; height: 46.4px;"><span class="td-span"><span class="md-plain">Address Type</span></span></td><td style="width: 8.40568%; height: 46.4px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 46.4px;"><span class="td-span"><span class="md-plain">The type of customer address such as Physical, Delivery or Postal. If unselected then the Delivery address is used.</span></span></td></tr><tr class="md-end-block" style="height: 46.4px;"><td style="width: 21.9947%; height: 46.4px;"><span class="td-span"><span class="md-plain">Validate Button</span></span></td><td style="width: 8.40568%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 10.8749%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 46.4px;"><span class="td-span"><span class="md-plain">Validating address is unsupported by Ship Logic. Click this button will show an error indicating this. <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span></span></td></tr><tr class="md-end-block" style="height: 64px;"><td style="width: 21.9947%; height: 64px;"><span class="td-span"><span class="md-plain">Update Customer Address </span><span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/6eLimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/6eLimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/6eLimage.png)</span></span></td><td style="width: 8.40568%; height: 64px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 10.8749%; height: 64px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 64px;"><span class="td-span"><span class="md-plain">Requires address validation to be supported. <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span></span></td></tr><tr class="md-end-block" style="height: 63.2px;"><td style="width: 21.9947%; height: 63.2px;"><span class="td-span"><span class="md-plain">Parcel Dimensions display field</span></span></td><td style="width: 8.40568%; height: 63.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 10.8749%; height: 63.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 63.2px;"><span class="td-span"><span class="md-plain">Displays the information about the current parcel selection for the shipment to be created. If blank then there is no parcel selection. If faded then the shipment was created for the parcel selection.</span></span></td></tr><tr class="md-end-block" style="height: 69.8px;"><td style="width: 21.9947%; height: 69.8px;"><span class="td-span"><span class="md-plain">Custom Parcel Dimensions button </span><span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/5kWimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/5kWimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/5kWimage.png)</span></span></td><td style="width: 8.40568%; height: 69.8px;"><span class="td-span"><span class="md-plain">N/A</span></span></td><td style="width: 10.8749%; height: 69.8px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 58.6999%; height: 69.8px;"><span class="td-span"><span class="md-plain">Clicking on this opens the Parcel Selection window, which is required for specifying information about the parcels for the shipment. This is explained in the next section. </span></span></td></tr><tr class="md-end-block" style="height: 46.4px;"><td style="width: 21.9947%; height: 46.4px;"><span class="td-span"><span class="md-plain">Service Type </span></span></td><td style="width: 8.40568%; height: 46.4px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 46.4px;"><span class="td-span"><span class="md-plain">Is now used to pre-select a rate from the list of available rates retrieved from ShipLogic that are presented when the Courier API button is clicked.</span></span></td></tr><tr class="md-end-block" style="height: 46.4px;"><td style="width: 21.9947%; height: 46.4px;"><span class="td-span"><span class="md-plain">Tracking No</span></span></td><td style="width: 8.40568%; height: 46.4px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 10.8749%; height: 46.4px;"> </td><td style="width: 58.6999%; height: 46.4px;"><span class="td-span"><span class="md-plain">Displays the last Tracking Number that is assigned to the Invoice. This can be edited and be related to shipping functions outside of ShipLogic.</span></span></td></tr><tr class="md-end-block" style="height: 63.2px;"><td style="width: 21.9947%; height: 63.2px;"><span class="td-span"><span class="md-plain">Tracking No buttons</span></span></td><td style="width: 8.40568%; height: 63.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 10.8749%; height: 63.2px;"> </td><td style="width: 58.6999%; height: 63.2px;"><span class="td-span"><span class="md-plain">These buttons can be used to add a new Tracking Number to the Invoice or view the list of existing Tracking Numbers for the Invoice. The tracking numbers do not need to have been created with Ship Logic.</span></span></td></tr><tr class="md-end-block" style="height: 63.2px;"><td style="width: 21.9947%; height: 63.2px;"><span class="td-span"><span class="md-plain">Delivery Status display field.</span></span></td><td style="width: 8.40568%; height: 63.2px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 63.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 63.2px;"><span class="td-span"><span class="md-plain">Displays the current shipping status for the last shipment created with Ship Logic.</span></span></td></tr><tr class="md-end-block" style="height: 60px;"><td style="width: 21.9947%; height: 60px;"><span class="td-span"><span class="md-plain">Update Delivery Status  
</span><span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/6eLimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/6eLimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/6eLimage.png)</span></span></td><td style="width: 8.40568%; height: 60px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 60px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 60px;"><span class="td-span"><span class="md-plain">Clicking this button will perform an API request with Ship Logic to update the Delivery Status display field.</span></span></td></tr><tr class="md-end-block" style="height: 63.2px;"><td style="width: 21.9947%; height: 63.2px;"><span class="td-span"><span class="md-plain">Auto checkbox</span></span></td><td style="width: 8.40568%; height: 63.2px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 63.2px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 58.6999%; height: 63.2px;"><span class="td-span"><span class="md-plain">Having this checked will cause the Delivery Status display field to be updated when the Invoice is opened and there is a shipment created with Ship Logic for it.</span></span></td></tr><tr class="md-end-block" style="height: 96.8px;"><td style="width: 21.9947%; height: 96.8px;"><span class="td-span"><span class="md-plain">Courier API button </span><span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/pvNimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/pvNimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/pvNimage.png)</span></span></td><td style="width: 8.40568%; height: 96.8px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 96.8px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 58.6999%; height: 96.8px;"><span class="td-span"><span class="md-plain">This button is required to be clicked on before a shipment for the Invoice can be created with Ship Logic. If there is a selection of parcels created, and the other requirements are met, a window with a list of available shipping rates, or services types, will be presented, of which one can be selected and a shipment created. <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span></span></td></tr><tr class="md-end-block" style="height: 67.8px;"><td style="width: 21.9947%; height: 67.8px;"><span class="td-span"><span class="md-plain">Details  
</span><span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/rVVimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/rVVimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/rVVimage.png)</span></span></td><td style="width: 8.40568%; height: 67.8px;"><span class="td-span"><span class="md-plain">No</span></span></td><td style="width: 10.8749%; height: 67.8px;"> </td><td style="width: 58.6999%; height: 67.8px;"><span class="td-span"><span class="md-plain">For unrelated shipping functions. The Pickup and Delivery instructions may also be set in the form that opens after clicking the button, but it is unnecessary when these fields already exist in the current form. </span></span></td></tr><tr class="md-end-block" style="height: 80px;"><td style="width: 21.9947%; height: 80px;"><span class="td-span"><span class="md-plain">Save Shipping </span><span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/rHsimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/rHsimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/rHsimage.png)</span></span></td><td style="width: 8.40568%; height: 80px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 10.8749%; height: 80px;"><span class="td-span"><span class="md-plain">Yes</span></span></td><td style="width: 58.6999%; height: 80px;"><span class="td-span"><span class="md-plain">Is required to save the Shipping Tab fields if the Invoice Save button is disabled as it is when the Invoice status is Posted. The Customer, Internal Contact and Reference fields are not saved. The Shipping Tab fields are also saved automatically when the Courier API button is clicked.</span></span></td></tr></tbody></table>

</figure>### <span class="md-plain">Parcel Selection Grid</span>

<span class="md-plain">The Parcel Selection Grid is opened in a new modal window by clicking the Custom Parcel Dimensions button </span><span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/aVgimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/aVgimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/aVgimage.png)</span><span class="md-plain"> next to the Parcel Dimensions field. It is required to have at least one parcel created before a new shipment can be created with Ship Logic.</span>

<span class="md-plain"> When there is one or more parcel for the new shipment, the Parcel Diminsions field in the Shipping tab of the Invoice form will be updated to reflect this. In this case the text is coloured black. If the parcel dimensions are greyed out, then the parcels the dimensions are for have been assigned to the last created shipment, and for to create a new shipment new parcel dimensions will need to be added <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span>.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/ceEimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/ceEimage.png)</span><span class="md-plain"> Example of Parcel Dimensions created for the next shipment.</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/ceEimage.png)</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/RY7image.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/RY7image.png)</span><span class="md-plain"> Example of Parcel Dimensions assigned to the last created shipment.</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/RY7image.png)</span>

<span class="md-plain">The Parcel Selection Grid is used for several purposes:</span>

- <span class="md-plain">As indicated before, to add and edit the required information about the parcel sizes for a new shipment</span>
- <span class="md-plain">Editing predefined parcel sizes to use instead of having to reenter the same values each time.</span>
- <span class="md-plain">Keeping a record of past shipments <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span>
- <span class="md-plain">Viewing and updating the tracking information for parcels that have been assigned to a shipment <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span>

#### <span class="md-plain">Editing Parcel Dimensions</span>

<span class="md-plain">For a shipment to be created with Ship Logic the dimensions and weight need to be specified. The quantity is optional and can be used instead of copying a parcel with the same dimensions and weight for the value of quantity.</span>

##### <span class="md-plain">Selection Grid </span>

<span class="md-meta-i-c  md-link" style="background-color: rgb(191, 237, 210);">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/A2Limage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/A2Limage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/A2Limage.png)</span>

<figure class="md-table-fig table-figure" id="bkmrk-component-descriptio"><table class="md-table" style="width: 100%;"><thead><tr class="md-end-block"><th style="width: 21.75%;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Component</span>**</span> </span></th><th style="width: 78.2253%;"><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Description</span>**</span> </span></th></tr></thead><tbody><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Search button</span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">Clicking this will reload the grid from the server</span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Add </span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">Clicking this opens a dialog to add a new parcel</span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Edit</span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">When one row is selected and is for a parcel without a shipment, the same dialog that is opened with the Add button is opened to edit information for the selected row.</span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Delete</span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">When at least one row is selected and the rows do not include rows for created shipments, the rows will be deleted without confirmation. Multiple rows are selected by holding down the control key and clicking on the rows to add to the selection.</span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Include Tracked <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">To include parcels with a shipment in the grid this checkbox is checked. To only show the parcels for the next shipment, it is unchecked. </span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Name column</span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">The name given to the parcel. This is not required by Ship Logic but is necessary if created from a parcel template.</span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Shipment column <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">This column is hidden by default. To unhide it, open the menu for the column and check the box for it in the "Columns" submenu. If there is a shipment number associated with the parcel then it is shown in the row. If there is not shipment number but there is tracking number then "Unavailable" is shown To group the rows by this column, open the menu for the column and click "Group by this field". </span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Shipment Created <span style="background-color: rgb(191, 237, 210);">\[NEW\]</span></span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">This column is hidden by default and needs to be enabled in the Columns submenu. If a shipment was created that includes the parcel this column will show the date and time it was created if this information is available.</span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Dimensions (L x W x H)</span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">Show the length, width and height of the parcel in centimeters </span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Wgt</span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">The weight in kilograms</span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Qty</span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">The number of parcels with the same dimensions and weight in the shipment</span></span></td></tr><tr class="md-end-block"><td style="width: 21.75%;"><span class="td-span"><span class="md-plain">Close button</span></span></td><td style="width: 78.2253%;"><span class="td-span"><span class="md-plain">Closes the window. When the window is closed the Parcel Dimensions field in the Shipping tab of the Invoice form will be refreshed from the server.</span></span></td></tr></tbody></table>

</figure>##### <span class="md-plain">Add / Edit dialog</span>

<span class="md-plain">Opened by clicking the Add or Edit buttons</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/D5ximage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/D5ximage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/D5ximage.png)</span>

<span class="md-plain">The Parcel combo box can be used to select a parcel template created in the Defaults grid and prefill the remaining fields. </span>

##### <span class="md-plain">Defaults grid</span>

<span class="md-plain">Lists predefined parcel dimensions that can be selected and added to the Selection grid for the next shipment.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/CHnimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/CHnimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/CHnimage.png)</span>

<span class="md-plain">To select more than one row, hold down the Control key before clicking on the next row. </span>

<span class="md-plain">When one or more rows are selected the Add Selected button becomes enabled. Clicking on it will create new parcel dimensions, with the values of the selected rows, in the Selection grid for the next shipment. When the new rows are added successfully, the tab is automatically switched to the Selection grid.</span>

#### <span class="md-plain">Editing Predefined Parcel Dimensions</span>

<span class="md-plain">To add and edit predefined parcel dimensions click the add and edit button respectively. A row needs to be selected before it can be edited. Multiple rows can be deleted together by selecting more than one by holding the Control key, and then clicking the Delete button. </span>

##### <span class="md-plain">Add / Edit Dialog</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/358image.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/358image.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/358image.png)</span>

<span class="md-plain">Entering a name is required and if a Courier API is selected then it is required to be unique for the selected API. The name will appear in the combo box in the add/edit dialog for the parcel selection grid. The dimensions and weight are required fields for Ship Logic. </span>

#### <span class="md-plain">Viewing Past Shipments</span>

<span class="md-plain">In the parcel selection grid, created shipments can be viewed by checking the Include Tracking checkbox. If a shipment was created with Ship Logic then the parcels for it should have the Shipment number assigned to it, the Shipment Created column will have the date and time the shipment was created and there should be a distinct tracking number for each parcel in the Tracking Number column. A column for the Tracking URL of each parcel in the shipment is also available. </span>

<span class="md-plain">If a parcel has a quantity greater than one, then in the Tracking Number and Tracking URL columns there will be a new line for each of the parcels that make up the quantity.</span>

<span class="md-plain">These columns are hidden by default and will need to be unhidden. </span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/K6Fimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/K6Fimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/K6Fimage.png)</span>

<span class="md-plain">Rows can be grouped by the Shipment number, but changing the sort order of groups is currently unsupported and the groups are always sorted in ascending order. To isolate to a single shipment, one can be selected from the Shipment combo box in the search panel. Available shipments are sorted by the time and date they were created in descending order.</span>

#### <span class="md-plain">Updating Tracking Information</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Xj2image.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Xj2image.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/Xj2image.png)</span>

<span class="md-plain">To update the Delivery Status for the parcels belonging to a shipment, select a row for a parcel with a Shipment number, then click the Status button in the top toolbar of the window. If successful then the columns API Status, API Parcel Status and Status Updated will be updated. The API Status column in the Delivery Status for the shipment, whereas the API Parcel Status is the delivery status of the parcel. The Status Updated column is the date and time the delivery status was last successfully updated. </span>

<span class="md-plain">If a parcel has a quantity greater than one, then in the API Parcel Status column there will be a new line for each of the parcelsthat make up the quantity.</span>

### <span class="md-plain">Creating a Shipment </span>

#### <span class="md-plain">Invoice Set up</span>

<span class="md-plain">A shipment is created Ship Logic from an Invoice by clicking on the Get Rates or Courier API button in the Shipping Tab when the required information has been saved to the Invoice and is correct. </span>

##### <span class="md-plain">Required Steps</span>

<span class="md-plain">To create a Shipment with Ship Logic from an Invoice document the following is required before clicking on the Get Rates or Courier API button in the Shipping Tab:</span>

- <span class="md-plain">The Invoice needs to have a Customer selected</span>
- <span class="md-plain">The address selected in the Address Type field needs to be valid for the Customer.</span>
- <span class="md-plain">An Internal Contact needs to be selected</span>
- <span class="md-plain">The Physical Address for the Branch the Internal Contact belongs to needs to be valid </span>
- <span class="md-plain">For an address to be valid it needs to be in the following format:</span>
    
    <figure class="md-table-fig table-figure"><table class="md-table"><thead><tr class="md-end-block"><th><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Field</span>**</span></span></th><th class=""><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Description</span>**</span></span></th><th><span class="td-span"><span class="md-pair-s ">**<span class="md-plain">Example</span>**</span> </span></th></tr></thead><tbody><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Address Line 1</span></span></td><td class=""><span class="td-span"><span class="md-plain">The street address</span></span></td><td><span class="td-span"><span class="md-plain">1188 Lois Avenue</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Address Line 2</span></span></td><td class=""><span class="td-span"><span class="md-plain">The suburb, or local area</span></span></td><td><span class="td-span"><span class="md-plain">Menlyn</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Address Line 3</span></span></td><td class=""><span class="td-span"><span class="md-plain">The city</span></span></td><td><span class="td-span"><span class="md-plain">Pretoria</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Address Line 4</span></span></td><td class=""><span class="td-span"><span class="md-plain">The region or province</span></span></td><td><span class="td-span"><span class="md-plain">Gauteng</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">Country</span></span></td><td class=""><span class="td-span"><span class="md-plain">The selected country, defaults to South Africa</span></span></td><td><span class="td-span"><span class="md-plain">South Africa</span></span></td></tr><tr class="md-end-block"><td><span class="td-span"><span class="md-plain">GPS Coords</span></span></td><td class=""><span class="td-span"><span class="md-plain">Optional GPS coordinates, comma separated latitude then longitude</span></span></td><td><span class="td-span"><span class="md-plain">-25.7863272, 28.334732</span></span></td></tr></tbody></table>
    
    </figure>
- <span class="md-plain">The Customer needs to have a default contact person, or the Contact Person in the Address tab needs to be given.</span>
- <span class="md-plain">The contact person needs to have a name and a valid contact number or email</span>
- <span class="md-plain">If the Contact Number field in the Address tab is used, then this replaces the Contact Number for the Contact Person</span>
- <span class="md-plain">The Internal Contact needs have a name and a valid contact number or email.</span>
- <span class="md-plain">From the Parcel Selection grid accessed from the Shipping Tab, there needs to be at least one parcel created, with dimensions and a weight, and that has not been assigned a Shipping number or Tracking number.</span>
- <span class="md-plain">The API needs to be set up correctly</span>
- <span class="md-plain">In the Shipping Tab the Shipping Terms that apply to Ship Logic needs to be selected</span>
- <span class="md-plain">In the Shipping Tab the Delivery Company for Ship Logic needs to be selected</span>
- <span class="md-plain">The Invoice needs to be saved. Unsaved information is not sent to Ship Logic. If it is a processed Invoice then clicking the Save Shipping button in the Shipping Tab can be used, however the Customer and fields outside of the Shipping Tab will not be saved. </span>

##### <span class="md-plain">Optional Steps</span>

- <span class="md-plain">If the Email checkbox is checked in Shipping Options in the Shipping Tab, then delivery updates are sent to the Internal Contact via email or SMS.</span>
- <span class="md-plain">Special instructions for collection and delivery can be set from the Shipping Tab in the Pickup and Delivery Instructions fields.</span>
- <span class="md-plain">If the Reference field in the Detail Tab is set then this becomes the Customer Reference</span>
- <span class="md-plain">Selecting a Service Type from the Shipping Tab will preselect it when the Rates Selection List is presented, if it is available. Otherwise, if Economy is available then it will be selected. </span>

#### <span class="md-plain">Selecting from the Available Rates</span>

<span class="md-plain">When the Invoice is ready clicking the Get Rates or Courier API button in the Shipping Tab will present a new window with a list of the available rates or Service Types and their associated costs and other relevant information. By default the Economy rate, if it is available will be preselected, but if the Service Type selected from the Shipping Tab is available it will be preselected instead. Another rate can be selected by clicking on it. When a rate is selected the Select button in thet bottom toolbar will be enabled.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/YD8CEeimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/YD8CEeimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/YD8CEeimage.png)</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/sKgimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/sKgimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/sKgimage.png)</span>

<span class="md-plain">Clicking the Select button will create a shipment with Ship Logic with the selected option.</span>

<span class="md-plain">Clicking the Cancel button will close the window without creating a shipment. </span>

<span class="md-plain">If the Select button was clicked and a Shipment was created successfully with Ship Logic, then a success message with the tracking number will appear.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Kgximage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Kgximage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/Kgximage.png)</span>

<span class="md-plain">The tracking number will also be added to the Invoice in the Tracking No field and to the Tracking Number list </span><span class="md-plain">opened by clicking the View Tracking Numbers button [![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Krjimage.png) ](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/Krjimage.png)</span><span class="md-plain">next to it.</span>

<span class="md-plain">When the success message is dismissed, the Waybills or parcel labels will be automatically downloaded by the browser as a PDF file. The shipping documents, which include the labels, will be saved as attachments to the Invoice.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/qaaimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/qaaimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/qaaimage.png)</span>

<span class="md-plain">The Parcel Dimensions field in the Shipping Tab will be greyed out to indicate that the parcels it references are assigned to a shipment.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/SyPimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/SyPimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/SyPimage.png)</span>

<span class="md-plain">In the Parcel Selection window the Shipment combo box will show the Shipment number for the created shipment with the date and time it was created.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Iydimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Iydimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/Iydimage.png)</span>

<span class="md-plain">The rows for the parcels belonging to the Shipment are updated as follows:</span>

- <span class="md-plain">The ID or number given to the Shipment by the Ship Logic will set in the Shipment column</span>
- <span class="md-plain">The Shipment Created column will be updated with date and time the Shipment was created</span>
- <span class="md-plain">The Status column will be updated to "In Transit"</span>
- <span class="md-plain">The API Status column is updapted with a description of the delivery status for the Shipment from the API</span>
- <span class="md-plain">The Tracking Numbers and Tracking URLs for each of the parcels will be set</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/HY6image.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/HY6image.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/HY6image.png)</span>

### <span class="md-plain">Attachments</span>

<span class="md-plain">The attachments created by Ship Logic can be viewed with other attachments for Invoice, in the Attachments window, opened by clicking the Attachments button in the top toolbar of the window for the Invoice.</span>

<span class="md-meta-i-c  md-link">[<span class="md-image md-img-loaded" data-src="https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/JACimage.png">![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/JACimage.png)</span>](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/JACimage.png)</span>

<span class="md-plain">The attachments added for the created shipment will include "ShipLogic" and the tracking number in their names.</span>

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/Swfimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/Swfimage.png)

### <span class="md-plain">Delivery Status Updates</span>

The Delivery Status for the last created shipment belonging to the Invoice can be updapted by clicking the Update Delivery Status button [![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/MvEimage.png) ](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/MvEimage.png)next to the Delivery Status field in the Shipping Tab. To automatically update the delivery status when any Invoice is opened the Auto checkbox next to the button can be checked.

[![image.png](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/scaled-1680-/3etimage.png)](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/3etimage.png)