PublicSimpleShipment

The customer code.

Type: string

The customer code will be provided by Laghezza

Example:

"ACME"

The shipment date.

The shipment date must be represented in ISO 8601.

Any of

Option 1
Option 2

Type: stringFormat: date

Type: null

Example:

"1970-01-01"

The shipment state.

Default: null

The shipment state.

Any of

SimpleShipmentState
Option 2

SimpleShipmentState

Type: enum (of string)

Must be one of:

"PREALERT"
"ADVICE"

Type: null

Example:

"ADVICE"

The simple shipment declaration type.

Default: null

DeclarationSimpleType

Type: enum (of string)

Must be one of:

"IMPORT"
"EXPORT"
"TRANSIT"
"EXS"

Type: null

Examples:

"IMPORT"

"EXPORT"

"TRANSIT"

The customer reference of the shipment.

Type: string

Example:

"121212/A"

Attachments

Default: []

Any of

Option 1
Option 2

Type: array
No Additional Items

Each item of this array must be:

Attachment

Type: object
No Additional Properties

The filename of the attachment

Type: string

Must be at most 256 characters long

Example:

"test.pdf"

The binary of the attachment

Default: null

The binary of the attachment in base64 encoding.

Any of

Option 1
Option 2

Type: stringFormat: binary

Type: null

Example:

"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAC0lEQVQYlWNgAAIAAAUAAdafFs0AAAAASUVORK5CYII="

The content_type of the attachment

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"application/pdf"

The category of the attachment

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Examples:

"FATTURA"

"DICHIARAZIONE_LIBERA_ESPORTAZIONE"

The year of the attachment

Default: null

Any of

Option 1
Option 2

Type: integer

Type: null

Examples:

The identification number of the attachment

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"FATT/2023/123"

Type: null

The Id of the JSON schema.

Type: string

Example:

"https://api.thebigalice.com/schema/customs/simple_shipment/v1.2/schema.json"

The shipment expire date.

Default: null

The shipment expire date must be represented in ISO 8601.

Any of

Option 1
Option 2

Type: stringFormat: date

Type: null

Example:

"1970-01-01"

The customer reference of the master shipment.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"CONSOL/A"

The customer department code.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"001"

The customer branch code.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"HQ"

The name of the customer operator.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"Mario Rossi"

The email of the customer operator.

Default: null

Any of

Option 1
Option 2

Type: stringFormat: email

Type: null

Example:

"mario.rossi@nomecliente.com"

The shipment declaration type.

Default: null

Refer to Box 1 of Commission Delegated Regulation (EU) 2016/341.

Any of

DeclarationType
Option 2

DeclarationType

Type: object
No Additional Properties

The first subdivision.

Default: null

In the first subdivision, enter the relevant Union code from Appendix D1.

Any of

Option 1
Option 2

Type: string

Must be at least 2 characters long

Must be at most 2 characters long

Type: null

Examples:

"IM"

"EX"

The second subdivision.

Default: null

In the second subdivision, enter the type of declaration using the relevant Union code from Appendix D1.

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Must be at most 1 characters long

Type: null

Example:

"A"

The third subdivision.

Default: null

In the third subdivision, enter the relevant Union code from Appendix D1.

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Must be at most 5 characters long

Type: null

Examples:

"T1"

"T2"

Type: null

The main regime of the customs declaration.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Examples:

"4000"

"1000"

The consignor-sender of the goods.

Default: null

Refer to Box 2 of Commission Delegated Regulation (EU) 2016/341.

Any of

PersonOrCompany
Option 2

PersonOrCompany

Type: object
No Additional Properties

The EORI of the person or the company.

Default: null

Only EU, The EORI of the person or the company.

Any of

Option 1
Option 2

Type: string

Must be at most 18 characters long

Type: null

Example:

"IT00852040112"

The name of the person or the company.

Type: string

Must be at most 150 characters long

Example:

"Laghezza S.p.A."

The address of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"Viale San Bartolomeo, 103"

The city of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Must be at most 50 characters long

Type: null

Example:

"La Spezia"

The postal code of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Must be at most 17 characters long

Type: null

Example:

"19125"

The province of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Must be at most 2 characters long

Type: null

Example:

"SP"

The country code of the person or the company.

Type: string

The country code must be represented in ISO 3166-1 alpha-2.

Must be at most 2 characters long

Example:

"IT"

The email of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: stringFormat: email

Type: null

Example:

"info@laghezza.com"

The language of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

The consignee-receiver of the goods.

Default: null

Refer to Box 8 of Commission Delegated Regulation (EU) 2016/341.

Any of

PersonOrCompany
Option 2

PersonOrCompany

Type: object
No Additional Properties

The EORI of the person or the company.

Default: null

Only EU, The EORI of the person or the company.

Any of

Option 1
Option 2

Type: string

Must be at most 18 characters long

Type: null

Example:

"IT00852040112"

The name of the person or the company.

Type: string

Must be at most 150 characters long

Example:

"Laghezza S.p.A."

The address of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"Viale San Bartolomeo, 103"

The city of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Must be at most 50 characters long

Type: null

Example:

"La Spezia"

The postal code of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Must be at most 17 characters long

Type: null

Example:

"19125"

The province of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Must be at most 2 characters long

Type: null

Example:

"SP"

The country code of the person or the company.

Type: string

The country code must be represented in ISO 3166-1 alpha-2.

Must be at most 2 characters long

Example:

"IT"

The email of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: stringFormat: email

Type: null

Example:

"info@laghezza.com"

The language of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

The representation.

Default: null

Refer to Box 14 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: integer

Type: null

Examples:

The declarant/representative.

Default: null

Refer to Box 14 of Commission Delegated Regulation (EU) 2016/341.

Any of

PersonOrCompany
Option 2

PersonOrCompany

Type: object
No Additional Properties

The EORI of the person or the company.

Default: null

Only EU, The EORI of the person or the company.

Any of

Option 1
Option 2

Type: string

Must be at most 18 characters long

Type: null

Example:

"IT00852040112"

The name of the person or the company.

Type: string

Must be at most 150 characters long

Example:

"Laghezza S.p.A."

The address of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"Viale San Bartolomeo, 103"

The city of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Must be at most 50 characters long

Type: null

Example:

"La Spezia"

The postal code of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Must be at most 17 characters long

Type: null

Example:

"19125"

The province of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Must be at most 2 characters long

Type: null

Example:

"SP"

The country code of the person or the company.

Type: string

The country code must be represented in ISO 3166-1 alpha-2.

Must be at most 2 characters long

Example:

"IT"

The email of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: stringFormat: email

Type: null

Example:

"info@laghezza.com"

The language of the person or the company.

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

The shipment note.

Default: null

Any further notes for the operator.

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"Please call me before proceed"

List of shipment note.

Default: []

Any further notes for the operator.

Any of

Option 1
Option 2

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Type: null

Example:

[
    "Please call me before proceed",
    "Urgent"
]

The country of dispatch/export.

Default: null

Refer to Box 15 of Commission Delegated Regulation (EU) 2016/341. The country code must be represented in ISO 3166-1 alpha-2.

Any of

Option 1
Option 2

Type: string

Must be at most 2 characters long

Type: null

Example:

"IT"

The country code of destination.

Default: null

Refer to Box 17 of Commission Delegated Regulation (EU) 2016/341.The country code must be represented in ISO 3166-1 alpha-2.

Any of

Option 1
Option 2

Type: string

Must be at most 2 characters long

Type: null

Example:

"US"

The port of discharge.

Default: null

The port code must be represented in LOCODE.

Any of

Option 1
Option 2

Type: string

Must be at most 5 characters long

Type: null

Example:

"ITSPE"

The port of loading.

Default: null

The port code must be represented in LOCODE.

Any of

Option 1
Option 2

Type: string

Must be at most 5 characters long

Type: null

Example:

"ITSPE"

The delivery terms code.

Default: null

Refer to Box 20 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"FCA"

The delivery terms location.

Default: null

Refer to Box 20 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"MILANO"

The office of exit or entry.

Default: null

Refer to Box 29 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: string

Must be at least 8 characters long

Must be at most 8 characters long

Type: null

Example:

"IT068100"

The country code of transport means.

Default: null

Refer to Box 18/21 of Commission Delegated Regulation (EU) 2016/341.The country code must be represented in ISO 3166-1 alpha-2.

Any of

Option 1
Option 2

Type: string

Must be at most 2 characters long

Type: null

Example:

"IT"

The identity of transport means.

Default: null

Refer to Box 18/21 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"MSC ALLEGRA"

The total number of packages.

Default: null

Refer to Box 6 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 0

Type: null

Examples:

The total gross mass in kilograms.

Default: null

Total gross mass of the declaration, sum of Box 35 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: number

Value must be greater or equal to 0.0

Type: null

Examples:

0.8

The total net mass in kilograms.

Default: null

Total net mass of the declaration, sum of Box 38 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: number

Value must be greater or equal to 0.0

Type: null

Examples:

0.8

The total volume in m3.

Default: null

The total volume of the goods in the declaration, when requested.

Any of

Option 1
Option 2

Type: number

Value must be greater or equal to 0.0

Type: null

Examples:

0.8

The total value of the goods and its currency.

Default: null

Refer to Box 22 of Commission Delegated Regulation (EU) 2016/341.

Any of

Amount
Option 2

Amount

Type: object

The amount value.

Any of

Option 1
Option 2

Type: number

Type: null

The amount currency.

Refer to ISO 4217

Any of

Option 1
Option 2

Type: string

Type: null

Examples:

"EUR"

"USD"

Type: null

Items

Type: array Default: []
No Additional Items

Each item of this array must be:

SimpleShipmentItem

Type: object
No Additional Properties

The type of packages.

Type: string

Refer to Box 31 of Commission Delegated Regulation (EU) 2016/341.

Examples:

"PK"

"CT"

The number of packages.

Type: integer

Refer to Box 31 of Commission Delegated Regulation (EU) 2016/341.

Value must be greater or equal to 0

Examples:

The item gross mass in kilograms.

Default: null

Refer to Box 35 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: number

Value must be greater or equal to 0.0

Type: null

Examples:

2.5

The item net mass in kilograms.

Default: null

Refer to Box 38 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: number

Value must be greater or equal to 0.0

Type: null

Examples:

2.5

The quantity expressed in the unit laid down in the goods nomenclature.

Default: null

Refer to Box 41 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: number

Value must be greater or equal to 0.0

Type: null

Example:

20.0

The description of the goods.

Default: null

Refer to Box 31 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"Plug valves for pipes"

The customs heading - hs code of the goods.

Default: null

Refer to Box 33 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: string

Must be at most 12 characters long

Type: null

Example:

"84818081"

The amount of the goods for this item.

Default: null

Refer to Box 46 of Commission Delegated Regulation (EU) 2016/341.

Any of

Amount
Option 2

Amount

Type: object

The amount value.

Any of

Option 1
Option 2

Type: number

Type: null

The amount currency.

Refer to ISO 4217

Any of

Option 1
Option 2

Type: string

Type: null

Examples:

"EUR"

"USD"

Type: null

The amount of Extra UE freight.

Default: null

Any of

Amount
Option 2

Amount

Type: object

The amount value.

Any of

Option 1
Option 2

Type: number

Type: null

The amount currency.

Refer to ISO 4217

Any of

Option 1
Option 2

Type: string

Type: null

Examples:

"EUR"

"USD"

Type: null

The amount of UE freight.

Default: null

Any of

Amount
Option 2

Amount

Type: object

The amount value.

Any of

Option 1
Option 2

Type: number

Type: null

The amount currency.

Refer to ISO 4217

Any of

Option 1
Option 2

Type: string

Type: null

Examples:

"EUR"

"USD"

Type: null

The amount of Local UE freight.

Default: null

Any of

Amount
Option 2

Amount

Type: object

The amount value.

Any of

Option 1
Option 2

Type: number

Type: null

The amount currency.

Refer to ISO 4217

Any of

Option 1
Option 2

Type: string

Type: null

Examples:

"EUR"

"USD"

Type: null

The country code of origin.

Default: null

Refer to Box 34A of Commission Delegated Regulation (EU) 2016/341.The country code must be represented in ISO 3166-1 alpha-2.

Any of

Option 1
Option 2

Type: string

Must be at most 2 characters long

Type: null

Example:

"CN"

Marks and numbers.

Default: null

Refer to Box 31 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"SN123456"

Item documents list.

Default: []

Refer to Box 44 of Commission Delegated Regulation (EU) 2016/341.

Any of

Option 1
Option 2

Type: array
No Additional Items

Each item of this array must be:

SimpleShipmentDocument

Type: object
No Additional Properties

The number of the document

Type: string

Example:

"123"

The category of the document

Type: string

Example:

"CAT123"

The reference of the document

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"REF123"

The country of the document

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"IT"

The year of the document

Default: null

Any of

Option 1
Option 2

Type: integer

Type: null

Example:

"2025"

The date of the document

Default: null

The document date must be represented in ISO 8601.

Any of

Option 1
Option 2

Type: stringFormat: date

Type: null

Example:

"2024-12-31"

Note referring to the document

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"Document created by Mario Rossi on 2024-12-31"

Type: null

Any additional shipment item info

Default: {}

Any of

Option 1
Option 2

Type: object

Each additional property must conform to the following schema

Any of

Type: string

Type: number

Type: integer

Type: boolean

Type: stringFormat: date

Type: null

Example:

{
    "Additional Item Info A": "string",
    "Additional Item Info B": 1.2,
    "Additional Item Info C": true,
    "Additional Item Info D": "2024-01-01"
}

Containers

Default: []

Any of

Option 1
Option 2

Type: array
No Additional Items

Each item of this array must be:

Container

Type: object
No Additional Properties

The container code.

Type: string

Example:

"MSCU1234567"

The container type.

Default: null

Refer to ISO 6346

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"40HC"

The list of container seals.

Default: []

Any of

Option 1
Option 2

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Type: null

Example:

[
    "S123456",
    "S123457"
]

Type: null

Documents

Default: []

Any of

Option 1
Option 2

Type: array
No Additional Items

Each item of this array must be:

SimpleShipmentDocument

Type: object
No Additional Properties

The number of the document

Type: string

Example:

"123"

The category of the document

Type: string

Example:

"CAT123"

The reference of the document

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"REF123"

The country of the document

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"IT"

The year of the document

Default: null

Any of

Option 1
Option 2

Type: integer

Type: null

Example:

"2025"

The date of the document

Default: null

The document date must be represented in ISO 8601.

Any of

Option 1
Option 2

Type: stringFormat: date

Type: null

Example:

"2024-12-31"

Note referring to the document

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Example:

"Document created by Mario Rossi on 2024-12-31"

Type: null

Any additional shipment info

Default: {}

Any of

Option 1
Option 2

Type: object

Each additional property must conform to the following schema

Any of

Type: string

Type: number

Type: integer

Type: boolean

Type: stringFormat: date

Type: null

Example:

{
    "Additional Info A": "string",
    "Additional Info B": 1.2,
    "Additional Info C": true,
    "Additional Info D": "2024-01-01"
}

PublicSimpleShipment

customer_code Required

The customer code.

shipment_date Required

The shipment date.

Any of

shipment_state

The shipment state.

Any of

SimpleShipmentState

Must be one of:

declaration_simple_type

The simple shipment declaration type.

Any of

DeclarationSimpleType

Must be one of:

customer_shipment_reference Required

The customer reference of the shipment.

attachments

Attachments

Any of

Each item of this array must be:

Attachment

filename Required

The filename of the attachment

binary

The binary of the attachment

Any of

content_type

The content_type of the attachment

Any of

category

The category of the attachment

Any of

year

The year of the attachment

Any of

identification_number

The identification number of the attachment

Any of

schema_id Required

The Id of the JSON schema.

expiration_date

The shipment expire date.

Any of

customer_shipment_master_reference

The customer reference of the master shipment.

Any of

customer_department_code

The customer department code.

Any of

customer_branch_code

The customer branch code.

Any of

customer_operator

The name of the customer operator.

Any of

customer_operator_email

The email of the customer operator.

Any of

declaration_type

The shipment declaration type.

Any of

DeclarationType

first_subdivision

The first subdivision.

Any of

second_subdivision

The second subdivision.

Any of

third_subdivision

The third subdivision.

Any of

regime

The main regime of the customs declaration.

Any of

consignor

The consignor-sender of the goods.

Any of

PersonOrCompany