Section

Field

Max Size 

TS

Max Size

Carrier

M/O/C

Comment

Input Parameters

ContractNumber

6

O

The customer number provided by La Poste Colissimo on opening your customer account.

Password

15

O

Password associated with the customer number entered and it must be identical to your customer account password.

OutputFormat

O

Contains the sub-tags linked to the format of the data sent by the Web Service.

Letter

O

Contains tags and blocks related to the shipment (options, parcel, sender, addressee, customs).

List of sub-blocks: Service (type of product and prices), Parcel (insurances and options), Sender, Addressee and CustomsDeclarations.

Fields

F

Can be used to fill in the ID Colissimo Pass: CPASSid.

The block service

ProductCode

O

Code indicating the desired product.

If the tag is A2P, BPR, ACP, CDI, CMT, BDP or PCS, the tag must be entered.

If the tag is DOM, DOS, BOS or BOM, the tag < pcikupLocationID> must be entered.

DepositDate

O

Scheduled deposit date in the La poste Network.

TransportationAmount

F

Basic shipment price without any options in eurocents.

TotalAmount

C

Basic shipping price increased by the price of shipment options.

OrderNumber

30

F

Customer order number (will not appear on the label)

CommercialName

C

Commercial name of the shipper. The tag is mandatory if the product code is A2P, BPR, BDP or CMT. The tag is not mandatory the product code is DOM or DOS.

ReturnTypeChoice

C

Indicates whether the parcel must be returned to the sender in case of non-delivery of the parcel. Mandatory for certain international parcels according to the applicable tariff areas.

The Block Parcel

InsuranceValue

F

Insured value.

By default, enter ‘false’ or ‘0’.

Maximum is €1500.

Enter 1230 for €12.30. (this value will be rounded off)

Options cannot be combined with the recommendation level.

RecommendationLevel

F

Can be R1, R2 and R3.

Weight

O

Weight of parcel in kg. 

NonMachinable

1

F

Parcel Format. If the product code is BPR, A2P, BDP or CMT, enter ‘false’ or ‘0’ by default. Enter ‘true’ or ‘0’ to indicate that the parcel format is non-stanard.

COD

F

Indicates whether delivery should be made on a reimbursable basis. By default enter ‘0’.

CODAmount

1

C

Amount expected for cash on delivery. By default enter ‘0’.

Mandatory if the value of COD is ‘true’ or ‘1’.

ReturnReceipt

1

F

Advice of receipt. By default enter ‘0’.

Instructions

35

F

Additional information for delivery labels or for Colissimo Return labels (return pattern).

PickupLocationID

6

C

Pick-up location identifier for Colissimo out of home delivery. Mandatory if the product code is A2P, BPR, ACP, CDI, CMT, BDP or PCS. Must be blank if the product code is DOM, DOS, BOS or BOM.

Ftd

1

F

Indicates the parcel is free of customs taxes. By default enter ‘0’. Mandatory by ‘true’ or ‘1’, for shipments overseas France only.

The Block Customs Declarations

IncludeCustomsDeclarations

1

F

Allows to include, in the response of the webservice, the generation of CN23 document in PDF format, relating to the articles declared in the webservice request.

‘True’ / ‘1’ = included by default in the webservice response.

‘False’/ ‘0’ = not generated.

Content

C

Represents the type of shipment and list of articles to declare. Mandatory if articles are eligible for the CN23 form.

  Description

64

O

Detailed description of the article.

Quantity

O

Number of articles of this type

  Weight

O

Unitary net weight of the articles in kg.

Value

O

Unitary value of articles in EUROS.

HsCode

10

C

Tariff number corresponding to the article

OriginCountry

2

C

ISO code for country of origin of the article.

Currency

3

C

Mandatory for the return inter (7R) product outside the EU. Currency must be the same for all articles.

Artref

44

C

Article reference, serial number. Mandatory for the return inter (7R) product outside the EU.

OriginalIdent

1

C

Key for identifying the outgoing invoice and he parcel related to the article. Mandatory for the return inter (7R) product outside the EU. If the article belongs to the first parcel, indicate A; if the article belongs to the third parcel, indicate C, etc.

Category

O

Containing the tag related to the nature of the shipment. Mandatory for products subject to a CN23 form.

Value

1

O

Type of shipment.

Original

C

Containing original data set(s). Mandatory for the return inter product outside the EU, up to 5 original data sets are approved.

OriginalIdent

1

C

Key for identifying the invoice and outgoing parcel related to article. Mandatory for the return inter (7R) product outside the EU. If the article belongs to the first parcel, indicate A; if the article belongs to the third parcel, indicate C, etc.

OriginalInvoiceNumber

35

C

For a return parcel.

OriginalInvoiceDate

10

C

For a return parcel. YYYY-MM-DD format.

OriginalParcelNumber

35

C

Mandatory for return parcel.

ImportersReference

35

F

Appears on the CN23 documents for shipments. Not used for return.

  FlowTransport

  6

O

Sens of the flow.

ImportersContact

35

F

Telephone or email.

  OfficeOrigin

35

F

Comments

35

F

Observations which do appear on the CN23 document.

InvoiceNumber

35

F

Identifier of related invoice document. Appears on the CN23 document.

LicenceNumber

35

F

Identifier of related import license document. Appears on the CN23 document.

CertificateNumber

35

F

Identifier of related certificate number document. Appears on the CN23 document.

ImporterAddress

F

Bloc Address

CompanyName

35

F

Appears on the CN23 document.

LastName

35

F

Appears on the CN23 document.

FirstName

29

F

Appears on the CN23 document.

Line0

35

F

Floor, hallway, stairs, apartment.

Line1

35

F

Entrance, building, residence.

Line2

35

F

Number and route label

Line3

35

F

Place said or other mention.

CountryCode

2

F

ISO Country code on 2 letters.

City

35

F

Appears on the CN23 document.

  ZipCode

  5

F

Appears on the CN23 document.

PhoneNumber

15

F

Appears on the CN23 document.

  MobileNumber

10

F

Appears on the CN23 document.

DoorCode1

8

F

DoorCode2

8

F

Email

80

F

Appears on the CN23 document.

Intercom

30

F

Language

2

F

Language of the notification e-mail to the sender. Used for tracking formation or SMS.

The Block Sender

SenderParcelRef

17

F

Sender Order Number

CompanyName

35

F

LastName

35

C

Mandatory if the tag is filled.

FirstName

29

C

Mandatory if the tag is filled.

Line0

35

F

Floor, hallway, stairs, apartment.

Line1

35

F

Entrance, building, residence.

Line2

35

C

Number and route label

Line3

35

F

Place said or other mention.

CountryCode

3

O

ISO Country code on 2 letters.

City

35

C

  ZipCode

  5

O

PhoneNumber

15

F

  MobileNumber

10

F

DoorCode1

8

F

DoorCode2

8

F

Email

80

C

Intercom

30

F

Language

2

F

The Block Addressee

AddresseeParcelRef

17

F

Recipient order reference.

CodeBarForReference

1

F

Allows to indicate the reference of the recipient in the form of a bar code on the label of the package. Enter ‘0’ by default or enter ‘1’ to show the value of the tag .

ServiceInfo

F

Name of the department in the company.

CompanyName

35

C

Mandatory for Colissimo retour. is CORE.

LastName

35

C

FirstName

29

C

Line0

35

F

Floor, hallway, stairs, apartment.

Line1

35

F

Entrance, building, residence.

Line2

35

C

Number and route label

Line3

35

F

Place said or other mention.

CountryCode

2

O

ISO Country code on 2 letters.

City

35

O

  ZipCode

  5

O

PhoneNumber

15

F

  MobileNumber

12

C

Mandatory if the tag is BPR or A2P.

DoorCode1

8

F

DoorCode2

8

F

Email

80

C

Mandatory if the is BDP or CMT.

Intercom

30

F

Language

2

F

Language requested for the e-mail notification to the recipient.

Colissimo Pass Offer

Key

C

Key word to be informed:

CPASSid: Colissimo pass id

Value

32

C

The expected value is the order identifier in the SI Colissimo.