Scroll Top
Logicon Shipping App

Logicon Shipping with Make

 

The Logicon Shipping App. Create a complete automated logistics solution with Logicon & Make.

 

Connect Logicon Shipping Prime to:

– create a consignment, add packages and manifest your consignment to a carrier.

– view shipments list, track shipments, monitor carriers, action exceptions, edit shipment details & much more… Integrate your shopping carts and marketplaces with Logicon and you are on your way to building a complete end-to-end e-commerce management system.

 

Innovate today, with Logicon logistics software-as-a-service way … 

 

                Fast, cost-effective, industry-leading apps & solutions.
favicon (1) (1)

Shipping APP PRIME

The Logicon Shipping app is a make Community application and part of the Logicon Shipping Module.

Logicon partner programme with Make and Make certified developers.

Register for a free 30 day trial for up to 500 shipments with your nominated carrier.

Logicon Systems Limited. Support, FAQs and documentation available online. 

         No credit card required

   Resource Library & FAQs

Available In This Release

favicon (1) (1)

Create a Consignment 

Create a new consignment on the Shipping Portal

favicon (1) (1)

Get a Consignment 

Locate a consignment by number, ID or other reference

favicon (1) (1)

Update a Consignment

Update a consignment’s parameters

favicon (1) (1)

Update a Package

Update an individual package’s parameters

favicon (1) (1)

Route a Consignment

Request consignment is routed to pre-defined carrier service

favicon (1) (1)

Manifest a Consignment  

Manifest existing consignment to a carrier service

favicon (1) (1)

Search for a Consignment 

Get a list of consignments based on search criteria 

favicon (1) (1)

Search for Packages

Get data on packages from selected search criteria

favicon (1) (1)

Reset Route for Consignment

Reset a consignment to another carrier service 

favicon (1) (1)

Reset Manifested Consignment 

Reset manifested consignment so it can be re-manifested 

favicon (1) (1)

Update a Consignment – post Manifest

Update a limited set of parameters after manifesting

favicon (1) (1)

Search for Tracking Events

Get a list of tracking events for a consignment or packages

favicon (1) (1)

Create a Tracking Event

Creates a new tracking event for the consignment

SHIPPING APP DOCUMENTATION LIBRARY

 









Logicon Shipping App 

Specification v1.0


Last Update – 2024-07-04







Contents

1. Introduction 3

1.1. Purpose 3

2. Making Logicon Shipping App available in your Make.com account 3

3. Create a Consignment 4

4. Change History 16















  1. Introduction

    1. Purpose


This document details the specification of multiple endpoints for Logicon V4 shipping application which will allow you to generate labels, apply tracking operations and use other available services in your Make.com cloud account. 


  1. Making Logicon Shipping App available in your Make.com account


During Logicon registration steps (or later in your profile) you will be required to enter following information in order for Logicon shipping application to become available in your Make.com cloud account:


Step 1

  • Your Make.com API key with following scopes:

    • apps:read

    • apps:write


To create API key login to your Make.com account go into your profile by clicking on your name in the bottom left corner, then navigating to the API section and then clicking the “Add token” button. Define name for the API key and select mentioned scopes.


Generate Make.com API key


Once you have the API key copy-paste it in Logicon.


Step 2

  • Your Make.com dashboard URL


After the login to your Make.com account – copy Make.com URL and paste it in Logicon field – “Make.com Dashboard – URL“ during registration process or in your profile.


Structure of URL should be similar to – https://eu2.make.com/organization/1502620/dashboard


Step 3

  • Once you are logged into Logicon go into your profile and retrieve your Logicon API key which you will need to use when creating a connection in Make.com for Logicon Shipping App.


Now you can start using Logicon in Make! Happy shipping. If you have any questions regarding the setup please contact us at – support@logilink.io 




  1. Create a Consignment


Main end-point of the application. Will create a consignment in Logicon shipping portal. In order to achieve that you will need to map fields below from the application of your choice. 


Table below represents parameters, their types and meaning.


Consignment:


Data Element (Parameter)

Mandatory

Type

Additional Information

Uploaded Date


Date / Time (Unix)

Remove from public application.

White Label ID


Integer

Remove from public application. API key will need to handle parameter value.

Client ID


Integer

Remove from public application. API key will need to handle parameter value.

User ID


Integer

Remove from public application. API key will need to handle parameter value.

Consignment Status


Integer

Remove from public application. 

Consignment Message


String

Remove from public application. 

To Manifest


Boolean

Remove from public application. We will use a separate end-point for manifesting.

Client Service Code


One of these 

String

Either one parameter is mandatory. Both parameters can not be used at the same time. You would use client service code if your routing is set up (e.g. Express, Economy) and carrier service id if you know and want to create a consignment for the specific carrier. If no value is provided then Logicon will assign a generic carrier to the consignment. 

Carrier Service ID

Integer

Client Reference

Yes

String

Define your client reference number which in most cases will be shown on the label. We recommend no more than 20 characters.

Batch Reference

Yes

String

Define batch reference number on which basis consignments are going to be grouped. E.g. ABCDE-YYMMDD 

Consignment Currency

Optional

String

Currency of the consignment, required for international shipping. 

Total Value

Optional

Number

Total value of the consignment, required for international shipping

Export Reason

Optional

String

Reason for export, required for international shipping. Possible values are:

Sale, Commercial Samples, Gift, Return, Documents

Terms of Trade

Optional

String

Terms of trade, required for international shipping. Possible values are: DAP, DDU, DDP, EXW, FAS, CIF, FOB

Unit Type for Weight

Yes

String

Unit type for weight (e.g. Kg, Lb)

Unit Type for Dimensions

Yes

String

Unit type for dimensions (e.g. Cm, In)

Pickup

Optional

Boolean

Define TRUE if pickup is required or FALSE if it is not. Empty value will be treated as FALSE.

Pickup Date

Optional

Date

Date of pickup (DD-MM-YYYY)

Pickup Time From

Optional

Time

Start time of pickup window (HH:mm)

Pickup Time To

Optional

Time

End time of pickup window (HH:mm)

cod

Optional

Boolean

Remove from public application. 

cod_payment_amount

Optional

Number

Remove from public application. 

cod_currency

Optional

String

Remove from public application. 

insurance

Optional

Boolean

Remove from public application. 

insurance_amount

Optional

Number

Remove from public application. 

insurance_currency

Optional

String

Remove from public application. 

Internal Notes

Optional

String

Internal notes for consignment

Client Notes

Optional

String

Notes from the client





sender

Yes

Object

Contains sender’s details

receiver

Yes

Object

Contains receiver’s details

packages

Yes

Array

Contains package details



Sender:


Data Element (Parameter)

Mandatory

Type

Additional Information

First Name

Yes

String

Sender’s first name. Limitation to 35 characters.

Last Name

Yes

String

Sender’s last name. Limitation to 35 characters

Company

Optional

String

Sender’s company name. Limitation to 40 characters

Phone

Optional

String

Sender’s phone number including international code. Limitation to 15 characters

Mobile

Optional

String

Sender’s mobile number including international code. Limitation to 15 characters

Email

Optional

String

Sender’s email address

Address 1

Yes

String

Sender’s primary address. Limitation to 35 characters.

Address 2

Optional

String

Sender’s secondary address. Limitation to 35 characters.

City

Yes

String

Sender’s city

Postcode

Yes

String

Sender’s postcode

Region

Optional

String

Sender’s region

Country

Yes

String

ISO 2 format (e.g. GB)

EORI Number

Optional

String

Sender’s EORI number

VAT Number

Optional

String

Sender’s VAT number

IOSS Number

Optional

String

Sender’s IOSS number

Company Registration Number

Optional

String

Sender’s company registration number

Passport Number

Optional

String

Sender’s passport number

Identity Card Number

Optional

String

Sender’s identity card number


Receiver:


Data Element (Parameter)

Mandatory

Type

Additional Information

First Name

Yes

String

Receiver’s first name. Limitation to 35 characters.

Last Name

Yes

String

Receiver’s last name. Limitation to 35 characters.

Company

Optional

String

Receiver’s company name. Limitation to 40 characters

Phone

Optional

String

Receiver’s phone number including international code. Limitation to 15 characters

Mobile

Optional

String

Receiver’s mobile number including international code. Limitation to 15 characters

Email

Optional

String

Receiver’s email address

Address 1

Yes

String

Receiver’s primary address

Address 2

Optional

String

Receiver’s secondary address

City

Yes

String

Receiver’s city

Postcode

Yes

String

Receiver’s postcode

Region

Optional

String

Receiver’s region

Country

Yes

String

ISO 2 format (e.g. GB)

Eori Number

Optional

String

Receiver’s EORI number

VAT Number

Optional

String

Receiver’s VAT number

IOSS Number

Optional

String

Receiver’s IOSS number

Company Registration Number

Optional

String

Receiver’s company registration number

Passport Number

Optional

String

Receiver’s passport number

Identity Card Number

Optional

String

Receiver’s identity card number



Packages Array:


Data Element (Parameter)

Mandatory

Type

Additional Information

Package Sequence

Optional

Number

Sequence number of the package

Client Reference

Optional

String

Client reference of the package

Carrier Number

Optional

String

When creating a consignment carrier number could be defined if required.

Reference 1

Optional

String


Reference 2

Optional

String


Reference 3

Optional

String


GTN

Optional

String

Grouped Tracked Number. Identifier to group packages which can be used to filter. E.g. Use the AirWay Bill number. During the supply chain more than one gtn can be applied to a package.

Pallet / Bag Number

Optional

String

Define packing number to distribute packing tasks

Content

Yes

String

Content description of the package

Volume

Optional

Number

Define packages volume in m3. If left blank will be calculated automatically.

Weight

Yes

Number

Physical weight of the package. Unit type is defined in the consignment object.

Height

Optional

Number

Height of the package. Unit type is defined in the consignment object.

Width

Optional

Number

Width of the package. Unit type is defined in the consignment object.

Length

Optional

Number

Length of the package. Unit type is defined in the consignment object.

Package Status

Optional

Number

Remove from public application. 





customs

Yes

Array

Contains customs details









Customs  Array:


Data Element (Parameter)

Mandatory

Type

Additional Information

code_type

Optional

String

Remove from public application. 

Item HS Code

Optional

String

Item HS code. Required for international shipping.

Description

Optional

String

Description of the item

Quantity

Yes

Number


Weight

Yes

Number

Physical weight of 1 unit of the item

Item SKU

Optional

String

SKU of the item

Value

Yes

Number

Value of 1 unit of the item

Currency

Optional

String

Currency of the item. If left blank and consignment currency is defined in the request – consignment currency will be used.

Origin

Optional

String

Origin country of the item. ISO 2 (e.g. GB).




Note: one consignment can have (contain) multiple packages while one package can have (contain) multiple customs items.


Json Example – Request:


{

    “token”: “sampleToken12345”,

    “operation”: “manifest”,

    “manifest”: true,

    “client_reference”: “CR12345”,

    “batch_reference”: “BR12345”,

    “client_service_name”: “Express”,

    “consignment_currency”: “USD”,

    “total_value”: 100.5,

    “export_reason”: “Sale”,

    “terms_of_trade”: “DAP”,

    “unit_type_for_weight”: “Kg”,

    “unit_type_for_dimensions”: “Cm”,

    “pickup”: true,

    “pickup_date”: “01-09-2023”,

    “pickup_time_from”: “09:00”,

    “pickup_time_to”: “17:00”,

    “cod”: true,

    “cod_payment_amount”: 100.5,

    “cod_currency”: “USD”,

    “insurance”: true,

    “insurance_amount”: 1000,

    “insurance_currency”: “USD”,

    “internal_notes”: “Handle with care”,

    “client_notes”: “Fragile items inside”,

    “sender”: {

        “first_name”: “John”,

        “last_name”: “Doe”,

        “company”: “JD Corp”,

        “phone”: “+441234567890”,

        “mobile”: “+441234567891”,

        “email”: “john.doe@jdcorp.com”,

        “address_1”: “123 Street”,

        “address_2”: “Suite 4B”,

        “city”: “London”,

        “postcode”: “W1A 1AA”,

        “region”: “Greater London”,

        “country”: “GB”,

        “eori_no”: “GB123456789000”,

        “vat_no”: “GB987654321”,

        “ioss_no”: “IM1234567890”,

        “comp_reg_no”: “01234567”,

        “passport_no”: “123456789”,

        “identity_card_no”: “ID9876543”

    },

    “receiver”: {

        “first_name”: “Jane”,

        “last_name”: “Smith”,

        “company”: “JS Inc”,

        “phone”: “+1234567890”,

        “mobile”: “+1234567891”,

        “email”: “jane.smith@jsinc.com”,

        “address_1”: “456 Avenue”,

        “address_2”: “Apt 7C”,

        “city”: “New York”,

        “postcode”: “10001”,

        “region”: “NY”,

        “country”: “US”,

        “eori_no”: “US1234567890”,

        “vat_no”: “US987654321”,

        “ioss_no”: “IM0987654321”,

        “comp_reg_no”: “98765432”,

        “passport_no”: “987654321”,

        “identity_card_no”: “ID1234567”

    },

    “packages”: [

        {

            “package_sequence”: 1,

            “client_reference”: “PKG12345”,

            “content”: “Electronics”,

            “volume”: 0.002,

            “weight”: 2.5,

            “height”: 10,

            “width”: 20,

            “length”: 30,

            “customs”: [

                {

                    “code_type”: “HS Code”,

                    “item_code”: “1234.56.78”,

                    “description”: “Electronic gadget”,

                    “quantity”: 1,

                    “weight”: 2.5,

                    “item_sku”: “ELE12345”,

                    “value”: 100.5,

                    “currency”: “USD”,

                    “origin”: “GB”

                }

            ]

        }

    ]

}









Response:


Data Element (Parameter)

Type

Additional Information

success

Boolean

Defines if consignment has been created in Logicon.

message

String

Success related message.

errorMessage

String

In case of failure to generate labels or insert consignment into Logicon error message is defined here.

packages

Array


package_sequence

String

Sequence number of the package.

package_no

String

Unique number of the package generated by Logicon. First two letters represent sender country in ISO format, two next letters represent recipient country in ISO Format.

client_reference

String

Reference given by a client and associated with the package. Logicon will reject consignment if the request would have client reference of a package which has been used by the same client before. Must be unique.

carrier_number

String

Number associated with the package provided by the carrier. In most cases this number is being used for tracking purposes.

tracking_url

String

Tracking URL of the package.

documents

Array

All the documents associated with the specific package.

type_code

String

Type of the document.

format

String

Format of the document.

content

String

URL to content of the document encoded in base64.



Json Example – Response (Success):


[

  {

“success”: true,

“data”: {

“message”: “Manifested successfully”,

“errorMessage”: “”,

“packages”: [

  {

“package_sequence”: “01”,

“package_no”: “GBUSLLDLR40426G”,

“client_reference”: “Client_Ref”,

“carrier_number”: “ABCDEFG001”,

“tracking_url”: “https://tracking.carrierx.com/?itemNumber=ABCDEFG001”,

“documents”: [

  {

“type_code”: “label”,

“format”: “PDF”,

“content”: “URL to Base64econdedPDF”

},

{

“type_code”: “customsInvoice”,

“format”: “PDF”,

“content”: “URL to Base64econdedPDF”

}

]


}

]



}

  }

]









Json Example – Response (Error):


[

  {

“success”: false,

“data”: {

“message”: “Manifesting error”,

“errorMessage”: “Receiver parameter “address 1” should be less than 35 characters “

}

   }

]






  1. Change History


Version

Date 

Reason for issue

V4.0

2023.09.06

Initial release supporting Logicon V4


Logicon Systems and Logilink Partners 

Payment for Shipping application and usage 

Lorem ipsum dolor sit ametcon sectetur adipisicing elit, sed doiusmod tempor incidi labore et dolore. agna aliqua.