DT_Flexibilite_Expedition_Web Service - Colissimo

Transcription

Flexibilité - Shipping
Business solutions
Colissimo Shipping Web service
Technical document - Version 1.62 / December 2015
Specifications of Colissimo Shipping Web Service
Flexibilité – Colissimo shipping web service – December 2015
1
I.
Introduction ............................................................................................................. 4
I.1
Purpose of the Document ....................................................................................... 4
I.2
Technical Prerequisites........................................................................................... 4
I.3
Coding of Formats ................................................................................................. 5
I.4
Coding of Conditions .............................................................................................. 5
I.5
Managing accented characters ................................................................................ 5
II.
The SLS Web Service ................................................................................................. 6
II.1
Access URL ........................................................................................................... 6
II.2
Security: recommendation of the HTTPS protocol ...................................................... 7
II.3 Format and Processing of the Response from the Web Service .................................... 8
II.3.1
Scalability of the Web Service ....................................................................... 9
II.3.2
Particularity for ZPL Labels............................................................................ 9
II.3.3
Particularity for the XML Frame ..................................................................... 9
II.4 generateLabel Method............................................................................................ 9
II.4.1
Information Required Depending on the Type of Parcel Requested ................... 10
II.4.2
generateLabel input parameters .................................................................. 11
II.4.2.1 OutputFormat Block ............................................................................... 11
II.4.2.2 Service Block (element of Letter)............................................................. 12
II.4.2.3 Parcel Block (element of Letter) .............................................................. 13
II.4.2.4 customsDeclarations Block (element of Letter) .......................................... 13
II.4.2.5 sender Block (element of Letter) ............................................................. 14
II.4.2.6 addressee Block (element of Letter) ......................................................... 14
II.4.3
generateLabel Response ............................................................................. 15
II.4.3.1 If you have requested a PDF, ZPL or DPL label .......................................... 15
II.4.3.2 If you have requested "XML" output ......................................................... 16
II.5 getProductInter Method ....................................................................................... 16
II.5.1
getProductInter Input Parameters ................................................................ 17
II.5.2
getProductInter Response ........................................................................... 17
II.6 getListMailBoxPickingDates Method ....................................................................... 17
II.6.1
getListMailBoxPickingDates Input Parameters ................................................ 18
II.6.2
getListMailBoxPickingDates Response ........................................................... 18
II.7 planPickup Method .............................................................................................. 18
II.7.1
planPickup Input Parameters ....................................................................... 19
II.7.2
planPickup Response .................................................................................. 19
III.
Classification .......................................................................................................... 20
III.1
Products available ........................................................................................... 20
III.2
Shipment Options ............................................................................................ 21
III.3
Label Formats ................................................................................................. 22
III.4
International Shipments or Shipments to Overseas France ................................... 22
III.4.1
Management of customs data ...................................................................... 23
III.4.2
"CN23" Customs Declaration Document ........................................................ 24
III.5
Other checks made .......................................................................................... 25
2
IV.
Contact .................................................................................................................. 26
V.
Annex 1: Error Codes .............................................................................................. 27
VI.
Annex 2: printed materials ....................................................................................... 32
VI.1
Display of data on the labels ............................................................................. 32
VI.2
Right side of the label (A4 format only) .............................................................. 32
VI.3
Freight List Model ............................................................................................ 34
VI.4
Contents of the list .......................................................................................... 35
VII.
Annex 3: Examples of SOAP envelopes .................................................................. 36
VII.1
getProductInter Method ................................................................................... 36
VII.2
generateLabel Method ...................................................................................... 36
VII.3
getListMailBoxPickingDates Method.................................................................... 39
VII.4
planPickup Method .......................................................................................... 39
3
I.
Introduction
I.1 Purpose of the Document
La Poste Colissimo makes the SLS, Simple Label Solution, available to its customers to
produce their franking labels.
This Web Service is used to create the documents associated with a parcel (labels and
customs documents), as well to send its electronic preadvice automatically to La Poste
Colissimo.
Abbreviation
Description
SLS
Simple Label Solution
JRE
Java TM Runtime Environment
XML
eXtensible Markup Language
XSL
eXtensible Stylesheet Language
XSLT
XSL Transformations
ZPL
Zebra Programming Language
soapUI
Web Service test open source
DPL
Datamax Programming Language
XOP
XML Optimized Packaging
MTOM
Message Transmission Optimization Mechanism
MIME
Multipurpose Internet Mail Extensions
HTTPS
HyperText Transfer Protocol Secure : secured transfer protocol
This document describes access and the particular uses of the Web Service.
I.2 Technical Prerequisites
To access your Web service, it is necessary to implement a SOAP client. Depending on the
programming language and version, you may need to install additional libraries.
If you use a thermal printer, you must also have knowledge of the system in order to be able
to send the data flows from the web service to your printer's USB port or network.
4
I.3 Coding of Formats
Code
Description
A
Alphabetical characters (no space or punctuation)
AN
N
D
T
DT
SUB
L
B
Any printable character
Numerical decimal characters from 0 to 9
Date
Time
Date and time
Block: list of sub-fields
Choice from among a list of values
Boolean (true/false; 1/0)
The numbers after these codes in the data descriptions indicate the length of the field. A
single number indicates a fixed length field (e.g. "N6" for numeric containing 6 characters)
two numbers separated by dots indicate the expected minimum and maximum lengths (e.g.
AN0..35 for alphanumeric which can be empty and have a maximum length of 35 characters).
I.4 Coding of Conditions
Code
O
Description
F
C
Optional data. This information can be supplied if present in the information system issuing the file.
Presence Conditioned by the content of another field in the same record. E.g. a parcel for which a
notification to the addressee is required must indicate the elements enabling this notification to be
transmitted (phone number and/or email address according to the case).
Mandatory data. The information carried by this data must always be present in the file
I.5 Managing accented characters
Characters must be UTF-8 encoded.
To ensure correct rendering on the labels and in the notifications sent to addressees,
accented characters present on input to the Web Service are replaced by their non-accented
equivalents (e.g. "é" will be replaced by "e").
5
II. The SLS Web Service
The customer invokes the SLS Web Service through an HTTP request encapsulating a request
for the creation of a shipping label for printing by the customer.
The label returned by the Web Service may, depending on the format requested on input, be
in one of the following forms (see III.3 Label Formats):
• a PDF document
• a ZPL frame
• a DPL frame
• an XML frame (raw data to be formatted for international shipments)
The SLS Web Service offers the following methods:
Operation
Description
generateLabel
Generates a shipment: electronic preadvice of the parcel +
associated documents (label and customs declarations)
getProductInter
Used for certain international destinations only
Returns the return options compatible with the
destination/delivery options requested (according to the tariff
areas)
getListMailBoxPickingDates
planPickup
Used only for Retour Colissimo France
Indicates whether an address is eligible for shipment from a
mailbox and if so what the date and time are of the next parcel
pick-up from this address.
Used only for Retour Colissimo France
Allows you request that a return parcel is picked up from the
return sender's mailbox.
Important: when calling these methods, the parameters must be entered in the order
defined in the wsdl, otherwise an "unmarshalling error" will be returned.
II.1 Access URL
The La Poste – Colissimo franking Web Service is available at:
https://ws.colissimo.fr/sls-ws/SlsServiceWS?wsdl
This service requires you to use your La Poste - Colissimo contract number and your
password that you may receive by email on starting your contract or on request to your usual
La Poste Colissimo sales contact.
The login credentials also enable you to access your customer web account at
https://www.colissimo.fr/entreprise
6
Caution:
You can change your password in the customer web account.
If you do so, you must also change it when invoking the Web Service,
otherwise access to the Web Service will be refused.
II.2 Security: recommendation of the HTTPS protocol
Since access to this web service is protected by an identifier and a password which are
sensitive data, La Poste - Colissimo recommends you use the HTTPS protocol for sending
these data.
Not using this protocol leaves you open to these identifiers being intercepted by a malicious
third party which would allow it to steal the account's identity and thus to:
- gain access to your corporate space (online invoice, parcel tracking)
- order products, invoiced to the account whose identity has been stolen
- gain access to the other solutions made available by La Poste - Colissimo
The terms of user for this solution specify that the Customer undertakes to take all relevant
measures to ensure the security and confidentiality of its identifier and password.
Any access and transmission of data made, and more widely, any operation made by using
the Customer's identifier and password are deemed to have been made by the latter.
7
II.3 Format and Processing of the Response from the Web
Service
Note:
The SLS web service uses the MTOM (Message Transmission Optimization Mechanism)
technology. This means that the label is attached in MIME format to the web service's
response.
According to the used programming language, it will be necessary to parse or not the
SOAP/XML+XOP response to extract the attachments.
Example of a return via SOAPUI of the generateLabel method for a PDF label:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:generateLabelResponse xmlns:ns2="http://sls.ws.coliposte.fr">
<return>
<messages>
<id>0</id>
<messageContent>Your request was successfully processed</messageContent>
<type>INFO</type>
</messages>
<labelResponse>
<label>
<xop:Include href="cid:[email protected]"
xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</label>
<cn23>
<xop:Include href="cid:[email protected]"
xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</cn23>
<parcelNumber>7Q05592274242</parcelNumber>
<pdfUrl>https://pfi.telintrans.fr/slsws/GetLabel?parcelNumber=7Q05592274242&signature=d0fe8cc2e3d35febd858b2f73b6a26cc4
edb8674820a7c4033982c08ad668374&includeCustomsDeclarations=true</pdfUrl>
</labelResponse>
</return>
</ns2:generateLabelResponse>
</soap:Body>
</soap:Envelope>
8
II.3.1 Scalability of the Web Service
Since the Web Service may undergo slight changes (e.g. increase in the number of output
elements returned), La Poste - Colissimo recommends that flexible and dynamic
programming logic is used.
II.3.2 Particularity for ZPL Labels
For thermal printing, labels generated by the web service use the "direct transfer" printing
mode. Check that your printer is not configured for the "thermal transfer" mode.
II.3.3 Particularity for the XML Frame
Caution:
This frame is only offered for international shipments.
The XML format requires first validating your labels which must comply with
precise standards which will regularly change. This output format is not
recommended as it is more complicated to implement for the e-retailer and
less scalable.
For simplified implementation, we recommend the use of labels in the
PDF, ZPL or DPL formats for thermal printers and the PDF format for
office printers (see III.3Label Formats).
For more information, contact our Customer Integration Solution team which
will send you the detailed specifications of the labels (see IV Contact).
II.4 generateLabel Method
Use this method to generate your shipments, whatever the requested product or destination
for the following products:
• Colissimo – Offre France
• Colissimo – Offre Internationale
• Colissimo – Offre Outre-Mer
• Colissimo Retour France / Colissimo Retour International
The products currently concerned are listed in the III.1 Products available paragraph. La
Poste - Colissimo may modify this list.
Note: it is preferable not to send an optional field when it is empty.
9
II.4.1 Information Required Depending on the Type of Parcel Requested
The following diagram indicates the parameters required for creating a parcel according to the product requested.
Mandatory information is shown in bold with an asterisk. Each field is explained in the following paragraphs.
Additional parameters per type of parcel requested
Any product
Identification
•
•
<contractNumber>*
<Password>*
Ouput formats
•
•
•
<OutputPrintingtType>*
<x>
<y>
Colissimo Metropolitan
France
Colissimo International /
France Overseas
--
__
--
--
--
--
--
According to desired product:
•
< insurance Value >
•
<recommendationLevel>
•
<<pickupLocationid>
•
<nonMachinable>
•
<COD>
<CODAmount>
•
According to desired product:
•
< insurance Value >
•
<returnReceipt>
•
<ftd>
•
<nonMachinable>
•
<returnType>
Bloc <sender> :
•
Bloc <address>*
Bloc <addressee> :
•
Bloc <address>*
Bloc <addressee> :
•
<companyName>*
•
<addresseeParcelRef>
<codeBarforReference>
•
•
<service lnfo>
Parcel options
•
<weight>*
•
•
< Insurance Value >
<nonMachinable>
Delivery services
•
•
<productCode>*
<depositeDate>*
•
•
<mailboxPicking>
<mailboxPickingDate>
Sender / Addressee
GenerateLabel: input parameters
Colissimo Retour
•
Customs
--
--
--
<commercialName>*
If CN23 to be included:
•
<totalAmount>*
According to country and product:
<returnTypeChoice>*
•
SICN23 to be included:
•
< contents>*
•
<includeCustomsDeclarations>
*mandatory
10
II.4.2 generateLabel input parameters
The input parameters expected by the generateLabel method are listed below as defined in
the wsdl. Any element sent that is not shown in this table will be ignored by the Web Service.
Data
Format
Condition
Comment
contractNumber
N6
O
Password
AN6…15
The Customer number 6 characters in length provided by La Poste
Colissimo on opening your customer account
Password associated with the customer number entered
outputFormat
Letter
O
O
It must be identical to your customer space password
Block: contains the sub-fields linked to the format of the data sent by
the Web Service
O
See II.4.2.1OutputFormat Block
Block: contains sub-fields and blocks related to the shipment (options,
parcel, sender, addressee, customs)
SUB
Lists sub-blocks (described below):
• Service: type of product and prices
• Parcel: insurances and options
• Sender: sender
• Addressee: addressee
• CustomsDeclarations: customs
SUB
SeeII.4.2.2 to II.4.2.4
II.4.2.1 OutputFormat Block
Data
X
11
Format
N-9999…9999
Condition
O
Y
N-120…120
O
outputPrintingType
dematerialized
L
B
O
N/A
Specifications Labelling web service
Comment
for thermal printing only
By default, enter "0" (zero)
allows horizontal adjustment of printing on the label (expressed
in points).
For the DPL:
If x <0: the label is shifted to the right
if x >0: the label is shifted to the left
For the ZPL:
If x <0: the label is shifted to the right
if x >0: the label is shifted to the left
for thermal printing only
allows vertical adjustment of printing on the label (expressed in
points).
For the DPL:
If x <0: the label is shifted up
if x >0: the label is shifted down
For the ZPL:
If x <0: the label is shifted up
if x >0: the label is shifted down
Label printing format (see III.3Label Formats)
Not used (La Poste internal use only)
Data
ReturnType
Format
Condition
L
F
Comment
Used for Colissimo Retour only. Defines the label transmission
mode
Possible values:
• SendPDFByMail: the label is also sent by email, as
an attachment, to the address indicated in the
"sender" block
• SendPDFLinkByMail: the label is also sent by email,
as a hypertext link, to the address indicated in the
"sender" block
By default, the label is sent in the Web Service response only
II.4.2.2 Service Block (element of Letter)
Data
Format
Condition
productCode
L
O
DepositDate
D
O
mailBoxPicking
B
C
mailBoxPickingDate
D
C
VatCode
vatPercentage
VatAmount
N
N
N
F
F
F
transportationAmount
N
F
totalAmount
N
C
orderNumber
N0…30
F
commercialName
AN
C
returnTypeChoice
L
C
Comment
Code indicating the desired product
For example: "CORE" for Colissimo Retour
See list of codes:III.1Products available
Scheduled deposit date in the La Poste network.
For example: "2015-12-23"
Used for the CORE code
Must equal "true" for the parcel to be deposited in a mailbox
Used for the CORE code
Date requested for picking up from the mailbox
Mandatory (and taken into account) only if mailBoxPicking is "true"
To find out the next available date, call the
getListMailBoxPickingDatesmethod
Shipping price in euro cents. For example: 4530 for €45.30
By default, enter 0
Mandatory for parcels requiring a CN23 declaration (see
III.4.1Management of customs data)
Shipping price inclusive of VAT in euro cents For example: 4530
for €45.30
Order number as indicated in your information system
Can be useful for searching for parcels using this field in the
ColiView tracking system (appears in the "customer ref." field)
Mandatory for So Colissimo parcels.
Commercial name of the shipper which will be displayed in email
notifications to the parcel addressees
Mandatory for certain international parcels, according to the
applicable tariff areas
Indicates whether the parcel must be returned to the sender in
case of non-delivery of the parcel
see III.4International Shipments or Shipments to Overseas
France
12
II.4.2.3 Parcel Block (element of Letter)
Data
parcelNumber
insuranceAmount
Format
AN13
N
Condition
C
F
insuranceValue
N
F
recommendationLevel
L
F
weight
N
O
nonMachinable
B
F
COD
B
F
CODAmount
N
F
returnReceipt
B
F
Instructions
AN0…70
F
pickupLocationId
N6
C
ftd
B
F
Comment
Insured value. Max= €1500
Pass 1230 for €12.30
This value is rounded to the nearest whole number (e.g. 12 euros
if 1232 is sent)
Registered item level (see III.2)
Can be "R1", or "R2", or "R3"
See III.2Shipment Options
Weight of the parcel in kg (see III.5)
For example: "5.50"
Set to true to indicate that the parcel format is non-standard (nonmachinable)
Set to true if the delivery is cash on delivery
Amount expected for the cash on delivery.
Advice of receipt (0=no; 1=yes)
Additional information for the delivery (e.g. "to the left of interior
gate")
If productCode = A2P, BPR, ACP, CDI, CMT, BDP
Identifier of the pick-up location (for an So Colissimo delivery to an
alternative pick up location)
For shipments to Overseas France only
Indicates whether the parcel is free of customs taxes
See III.4International Shipments or Shipments to Overseas
France
II.4.2.4 customsDeclarations Block (element of Letter)
These parameters are mandatory only for destinations requiring a CN23 customs declaration.
Data
IncludeCustomsDeclarations
Format
B
Condition Comment
Indicates whether the CN23 declaration must be returned or
not by generateLabel
F
By default, set to true (CN23 included)
Contents
Item
Description
Quantity
SUB
C
SUB
AN1…64
N
O
O
Block: type of shipment and list of articles to
declare
Mandatory if shipments eligible for the CN23
The "article" block can be repeated up to 19 times
Detailed description of the article.
Number of articles of this type
13
Data
Weight
Value
Format
N
N
HsCode
N
OriginCountry
Category
A2
SUB
Value
N1
AN35
AN35
AN35
ImportersReference
ImportersContact
OfficeOrigin
Condition Comment
Unitary net weight of the articles in kg
O
Unitary value of the articles in EUROS (see III.4.1)
O
Tariff number corresponding to the article
Mandatory if category=3 (commercial shipment)
C
See III.4.1Management of customs data
ISO code of the country of origin of the article
C
O
Type of shipment (see III.4.1 Management of customs
O
data)
Importer's reference number
F
Importer's contact details (phone/email)
F
Office of origin
F
II.4.2.5 sender Block (element of Letter)
Data
senderParcelRef
Format
AN
Condition
F
address
Block: sender's address
companyName
lastName
firstName
line0
line1
line2
line3
AN35
A35
A29
AN35
AN35
AN35
AN35
countryCode
A2
city
zipCode
phoneNumber
mobileNumber
doorCode1
doorCode2
AN35
AN5
AN15
AN10
AN8
AN8
O
O
F
F
F
F
email
AN80
F
intercom
AN30
F
Language
A2
F
F
F
F
F
F
O
F
O
Comment
Internal parcel reference number for the sender.
Company name
Last name
First name
Floor, corridor, staircase, apartment no.
Entrance, building, residence
Number and street name For example: "5 rue du Bellay"
Named place or other special mention
2-letter ISO country code
For example: "FR" for France (see III.4 International Shipments
or Shipments to Overseas France)
City
Postcode
Landline phone number
Mobile number
Door code 1
Door code 2
in the form: <Text>@<Text>.<Text>
used for sending tracking notifications by email
Intercom
Sender's language (used for sending tracking notifications by email
or SMS)
By default: FR
II.4.2.6 addressee Block (element of Letter)
Data
Format
Condition
adresseeParcelRef
AN15
F
codeBarForReference
B
F
serviceInfo
AN
F
Comment
Parcel reference number for the addressee (for return parcels). Not
used in Coliview
Used for Colissimo Retour only ("CORE")
To display the addresseParcelRef data in the form of a barcode
on the parcel label, set to true
Used for Colissimo Retour only ("CORE")
14
Data
Format
Condition
promotionCode
AN
N/A
Address
Block: addressee's address
companyName
AN35
C
LastName
A35
O
FirstName
A29
C
line0
line1
line2
AN35
AN35
AN35
F
F
O
line3
AN35
F
countryCode
A2
City
zipCode
phoneNumber
mobileNumber
doorCode1
doorCode2
AN35
AN5
AN15
AN10
AN8
AN8
O
O
F
F
F
F
email
AN80
C
intercom
AN30
F
language
A2
F
Comment
Name of the department in the company (e.g. "Returns
department")
Mandatory for Colissimo Retour ("CORE")
Company name
Name
First name
Mandatory for So Colissimo
Number and street name For example: "5 rue du Bellay"
Named place or other mention
Note: this line is not displayed on international labels
2-letter ISO country code
For example: "FR" for France (see III.4 International Shipments
or Shipments to Overseas France)
City
Postcode
Landline phone number
Mobile number. Used for sending tracking notifications by SMS
Door code 1
Door code 2
in the form: <Text>@<Text>.<Text>
Used for sending tracking notifications by email
Mandatory for So Colissimo
Intercom
Addressee's language (used for sending tracking notifications by
email or SMS)
By default: FR
O
II.4.3 generateLabel Response
II.4.3.1 If you have requested a PDF, ZPL or DPL label
The generateLabel method will return the data below if in the web service input you have
set the "outputPrintingType" parameter to one of the following values:
• ZPL_10x15_203dpi
• ZPL_10x15_300dpi
• DPL_10x15_203dpi
• DPL_10x15_300dpi
• PDF_10x15_300dpi
• PDF_A4_300dpi
Data
Format
Condition
label
O
cn23
C
parcelNumber
O
Comment
Parcel label
Binary transmitted as an attachment (XOP), whatever the
value of outputPrintingType
CN23 PDF
Binary transmitted as an attachment (XOP) when
necessary (see III.4.1 Management of customs data)
Generated parcel number
Belongs to the number range allocated by La Poste
Colissimo for the corresponding product code
15
Data
Format
Condition
parcelNumberPartner
C
pdfUrl
C
Comment
Parcel number for the foreign partner
Returned for international parcels only
Only if a PDF format is requested: link for downloading the
pdf label
Note: not returned for Retour International labels
(productCode "CORI")
messages
id
type
messageContent
O
O
O
message ID
Type of message: ERROR, INFO, WARNING
message content
II.4.3.2 If you have requested "XML" output
This XML frame is only offered for international labels.
Refer to the particular documentation sent by our Customer Solution Integration team during
the label validation procedure (see IV Contact).
II.5 getProductInter Method
Use this function only for international shipments if you wish to know what return options are
compatible with the requested destination (e.g. "paid for return", "do not return", see
example below).
The return option entered is transmitted to our international partners to indicate what action
is required if the parcel cannot be delivered to the addressee (see III.4 International
Shipments or Shipments to Overseas France).
Do not return to the sender
16
Elements of the label may change.
II.5.1 getProductInter Input Parameters
The input parameters expected by the getProductInter method are listed below. Any
element sent that is not shown in this table will be ignored by the Web Service.
The parameters must be entered in the order defined in the wsdl, otherwise an
"unmarshalling error" will be returned.
Data
Format
Condition
Comment
contractNumber
N6
O
password
AN
productCode
A
O
insurance
B
F
nonMachinable
B
F
returnReceipt
B
F
countryCode
A2
C
zipCode
AN
C
O
see III.1Products available
Insured value (0=no; 1=yes)
By default, 0
Set to true to indicate that the parcel format is non-standard (nonmachinable). By default, false
Advice of receipt (0=no;1=yes)
By default, 0
ISO code of the country of destination. For example: "DE" for
Germany
Addressee postcode
II.5.2 getProductInter Response
Data
Format
product
A
partnerType
N
returnTypeChoice
SUB
Condition
Comment
Code corresponding to the first 2 characters of your parcel
number.
See paragraph III.1 for the complete list of possible products.
Not used: internal use
lists the return options available for the destination and the
options requested on input
See III.4International Shipments or Shipments to
Overseas France
O
O
O
message ID
Type of message: ERROR, INFO, WARNING
message content
messages
id
type
messageContent
II.6 getListMailBoxPickingDates Method
The getListMailBoxPickingDates() methods indicates whether an address is eligible for
shipment from a mailbox and if so what the dateand time are of the next parcel pick-up from
this address.
17
II.6.1 getListMailBoxPickingDates Input Parameters
Data
Format
Condition
Comment
ContractNumber
N6
O
Password
AN
Sender
line0
line1
line2
line3
SUB
AN35
AN35
AN35
AN35
O
F
F
O
F
countryCode
A2
O
zipCode
city
AN5
AN35
O
F
O
Number and street name. For example: "5 rue du Bellay"
Country code
Only the "FR" value is authorised
Postcode
City
II.6.2 getListMailBoxPickingDates Response
Data
Format Condition
Comment
id
N6
Message ID
messageContent
AN
Wording of message
mailBoxPickingDateMaxHour
T
Deadline time for picking up from the mailbox
For example: "9.00"
mailBoxPickingDates
SUB
Date for picking up from mailbox in the form "2015-0327T00:00:00+01:00"
Deadline time for a pick-up request
validityTime
For example: "23.00"
T
Any request for a pick-up for the next day must be made
before 23.00 (Deadline time for making a request for a pickup from a mailbox). If the request is made after 23.00, the
service returns a 30806 error
II.7 planPickup Method
The planPickup () method allows you to make a request for picking up a return parcel
deposited by the sender in their mailbox. The parcel must have previously been announced to
La Poste.
18
II.7.1 planPickup Input Parameters
Data
Format
Condition
Comment
ContractNumber
N6
O
Password
AN
parcelNumber
AN13
mailBoxPickingDate
D
Sender
companyName
SUB
AN35
countryCode
AN35
AN29
AN35
AN35
AN35
AN35
AN5
AN35
A2
email
AN80
phoneNumber
AN15
lastName
firstName
line0
line1
line2
line3
zipCode
city
O
O
Parcel number
O
Requested pick-up date
O
Company name
F
O
O
F
F
O
F
O
O
Name
First name
Number and street name. For example: "5 rue du Bellay"
Postcode
City
Country code
Only the "FR" value is authorised
Email address Used for sending tracking notifications to
addressees
Telephone
O
O
F
II.7.2 planPickup Response
Data
Format Condition Comment
id
N6
O
Message ID
messageContent
AN
O
Message content
19
III. Classification
The data returned by the Web Service vary according to the parcel destination and label
formats agreed with our international partners.
III.1 Products available
The following table lists the possible values for the productCode input parameter, and for
each of these values the solution which is associated with it, as well as the product codes that
can be returned by the web service to create the parcel number.
The value of the productCode field designates the parcel product to be created, according to
its delivery characteristics (type of solution, destination, mode of delivery).
Zone
Solution
Product codes
returned by the WS
productCode
to pass
(first 2 characters of the
parcel number)
France
France
France
France
France
France
France
International
Overseas
Overseas
International
International
(Belgique)
International
(Belgique)
International
(Belgique)
International
(Belgique)
France
France
France
Colissimo Domicile - sans signature
= Home without signature
Colissimo Domicile - avec signature
= Home with signature
Colissimo - Point Retrait – A La Poste
= at post office
Colissimo - Point Retrait – en relais Pick-up or en consigne Pick-up
Station
= at outside locations or stations from Pick-Up Services
Colissimo Retour France
Colissimo Retour International
Colissimo Expert International
Colissimo - Point Retrait – en relais
= at outside locations
Colissimo Point Retrait – en bureau de poste
= at post office
Colissimo Domicile - sans signature – Profil
Colissimo - Point Retrait – A La Poste – Profil
= at post office
Colissimo - Point Retrait – en relais Pickup ou en consigne Pickup
Station – Profil
= at outside locations or stations from Pick-Up Services
9L
6A
9V
6C
6H
COLD
DOM
COL
DOS
BPR*
A2P
6M
8R
CORE
7R
CORI
8Q
7Q
CP or EY
CM
CA
CB
CI
COM
CDS
COLI
CMT
DOM
DOS
BDP
DOM
6Q
BPR*
6R
A2P
6W
20
International
(Belgique)
International
(Belgique)
International
(Belgique)
Colissimo Domicile - sans signature - Profil
Colissimo Point Retrait – en bureau de poste - Profil
= at post office
Colissimo Point Retrait – en relais - Profil
= at outside locations
DOM
CQ
BDP
CU
CMT
CT
(*)
The code « BPR » must be used if your “Delivery Options” solution returns value « BPR », « ACP » or
« CDI » for the delivery mode.
III.2 Shipment Options
Not all La Poste - Colissimo products have the same shipment options available.
From the productType passed on input, the Web Service will only take into account options
associated with your product.
The paragraphs below describe some of these options.
Registered item level: "recommendationLevel" parameter:
3 levels of fixed price insurance for registered items (see tariffs in force)
Possible values
Description
R1
up to €31
R2
up to €153
R3
up to €458
Cash on delivery: "COD" / "CODAmount" parameters:
If the delivery is cash on delivery, set "COD" to true (or "1"), and enter the amount in
question in "CODAmount", in euro cents (e.g. "4340" for €43.40)
Insured value: "insuranceValue" parameter:
The optional insurance can be for a maximum amount of €1,500, in tranches of €150
for the computerised solution. Enter in "insuranceValue" a value in euro cents (e.g.
"4300" for €43). This value is rounded to the nearest whole number (e.g. to €43 if
"4345" is entered).
Non-standard shipment: "nonMachinable" parameter:
To report a so-called "bulky" or non-stable shipment. For more details, refer to the
Shipment FAQ on colissimo.fr
Advice of receipt: "returnReceipt" parameter:
To be informed by postal mail of receipt and the date of delivery of the parcel to the
addressee, set "returnReceipt" to true or 1.
Free of taxes and duty: "ftd" parameter:
If you want to bear the cost of customs duties where parcels are taxed (for shipments
to the OM1 area, excluding Saint-Pierre-et-Miquelon and Mayotte), set "ftd" to true or
1.
21
III.3 Label Formats
The La Poste - Colissimo franking Web Service allows you to choose the format of the labels
you want to obtain in return for each call, via the "outputPrintingType" input parameter
which offers different combinations of format/dimension/resolution.
This parameter can take the following values:
Value
ZPL_10x15_203dpi
ZPL_10x15_300dpi
DPL_10x15_203dpi
DPL_10x15_300dpi
PDF_10x15_300dpi
PDF_A4_300dpi
XML
Description
Types of compatible printers
ZPL thermal printing, dimension 10cm x 15cm, and
resolution of 203dpi
ZPL thermal printing, dimension 10cm x 15cm, and
DPL thermal printing, dimension 10cm x 15cm, and
DPL thermal printing, dimension 10cm x 15cm, and
PDF office printing, dimension 10cm x 15cm, and
PDF office printing, dimension A4 and resolution of
300dpi
XML return (raw data to be formatted by the shipper)
solution not recommended (each label model requires
validation by La Poste - Colissimo)
Zebra thermal 203 dpi
Zebra thermal 300 dpi
Datamax thermal 203 dpi
Datamax thermal 300 dpi
Office,
Office
Depends on the formatting carried out by
the shipper
Comments:
We advise shippers with high printing volumes (of over 1,000 packages per month) to
choose the thermal formats (ZPL or DPL) to make their logistics chain more fluid.
The label masks generated by our PDF, ZPL and DPL outputs must be printed without
resizing not to alter the quality of the barcodes.
If additional elements need to be displayed on the printing medium, it is
recommended to do so outside of the 10x15 mask of the label generated by our Web
Service, without which La Poste - Colissimo could not be held responsible for reading
problems in our network.
III.4 International Shipments or Shipments to Overseas
France
"countryCode" parameters:
The country codes transmitted in the countryCode parameters must correspond to
the ISO 3166 Coding Table: https://www.iso.org/obp/ui/fr/#search.
"zipCode" parameters:
The validity of the postcode format is checked for the country of destination (according
to the country code transmitted in countryCode). For example, a verification will be
made that a postcode transmitted to Canada contains 6 characters. Note. For special
territories attached to other countries, the countryCode must be that of the special
22
territory, and not that of its country of attachment (e.g. "GL" for Greenland attached
to Denmark, and not "DK").
"returnTypeChoice" parameter:
Key designating the action to be performed in the event of a parcel return (for the
Expert I or Colissimo International solutions)
To know what options are allowed for a country, call the getproductinter method.
More information on colissimo.fr
Option in case of non-delivery
Wording on the label
First class paid return
(Outside the European Union only)
Return to the sender as priority parcel
Do not return
(All destinations)
Do not return to the sender
Value of
<returnTypeChoice>
2
3
III.4.1 Management of customs data
La Poste has an obligation for certain countries to transmit the CN23 declaration in a
dematerialised version to its partners responsible for the customs clearance of the goods.
That is why, for parcels to destinations requiring a customs declaration on the CN23 form, the
CN23 information must be transmitted to La Poste by the Web Service.
If the CN23 data are not transmitted or are incomplete, the web service returns a warning
code, but the label can still be printed.
Providing the CN23 data however remains the responsibility of the shipper customer.
"category" parameter:
Indicates the type of the shipment (for international shipments or shipments to
overseas France to which the CN23 applies). It can take only the following values:
Possible values
Description
1
Gift
2
Commercial sample
3
Commercial parcel
4
Document
5
Other
6
Return of goods
"value" parameter:
• Unitary value of articles in EUROS
• Only 2 decimals different from 0 are accepted
Where the data required for creating the CN23 are supplied to La Poste Colissimo, this
document is returned to you in the response to the generateLabel method (<cn23>
element), in 4 copies, in the form of a single PDF file (regardless of the print mode of the
parcel label requested).
"hsCode" parameter:
23
Since 1988, the European Community, after many countries worldwide, adopted the
Harmonized System (HS) for the description of goods for commercial shipments.
This 6-digit "tariff number" allows all physical objects uniquely and worldwide to be
identified. It is one of the three elements used to establish the customs duties,
alongside the carriage costs and the origin of the goods.
To allow fast processing of customs operations on arrival in the country of destination,
we thus recommend that companies indicate the tariff number of the good sent.
For goods sent by post, only the indication of the 6-digit tariff number is an obligation
for the forwarding agents.
Where to obtain the tariff number?
o Contact the customs offices of your for regular shipments
o Visit the French customs website: https://pro.douane.gouv.fr/prodouane.asp (in
the RITA, the national comprehensive listing of tariffs, consult the classification)
III.4.2 "CN23" Customs Declaration Document
This mandatory declaration must be issued for customs clearance of parcels shipped abroad.
It must be printed in 4 copies attached to the parcel.
The document can be published via the Web Service or the customer’s own resources.
24
III.5 Other checks made
"weight" parameter:
Parcel weight in kg.
Min: 0.01 kg
Max: 30.00 kg or the max weight of the pick-up location
Only 2 decimals different from 0 are accepted
The status of the customer account: a terminated customer account will not allow
labels to be generated
25
IV. Contact
La Poste - Colissimo provides you with support, which we advise you to call in the following
cases:
For any technical issue related with the solution described
in this document:
• Client Solutions Support, at 0241.742.088, from
Monday to Friday, 9 am to 6 pm.
Preliminary study
Solution deployment
Operational phase,
To confirm the solution chosen:
• Your La Poste – Colissimo sales contact
• A case number will be provided by Customer
Solutions Support once the request is entered into
the system.
For any issue relating to the implementation:
• Client Solutions Support, at 0241.742.088, from
Monday to Friday, 9 am to 6 pm.
In case of failure, anomaly or incident:
• The Service Centre
on 0825.086.005,
from Monday to Friday from 8am to 6pm.
after solution deployment
The availability and proper operation of our systems are
supervised, even outside these times.
The physical test sets must be sent to the following address:
LA POSTE - Parcel Unit / Customer Integration Support
<Last name and first name of your contact>
Bâtiment Aphélion, 6ème étage
62, rue Camille Desmoulins
92130 ISSY LES MOULINEAUX
FRANCE-FR
26
V.
Annex 1: Error Codes
These are possible values of the <id> element present in the definition of the <message>
type. The cause of the error is described in the associated <libelle> element.
String type parameters whose length exceeds the authorised length will be truncated to the
right. A warning message and a code will be added to the response's "Message" parameter.
Code
0
1
30000
30002
30007
Type
INFOS
ERROR
ERROR
ERROR
ERROR
30008
ERROR
30045
ERROR
ERROR
30046
30047
30010
30014
30015
30017
30018
30020
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
30022
30023
30025
30026
30065
30043
30045
30046
30047
30085
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
30089
ERROR
30090
ERROR
30100
ERROR
30102
30103
30104
30106
30107
30108
30109
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
Comment
The request has been processed successfully
The request has failed
Invalid identifier/password
The deposit date is prior to the current date
Inactive client. Please contact your sales
representative.
Unauthorised service for this identifier Please
contact your sales representative in order to reset
your customer account
The sender's email has not been sent
The sender's email is incorrect.
The sender's e-mail is wrongly formatted. To be
valid, it must have the format: [email protected]
The sender's phone number is incorrect
The date has not been sent
The product code has not been sent
The product code is incorrect
The value of the cash on delivery field is incorrect
The commercial name has not been sent
The total amount of the shipping costs has not
been sent
The sender's language is incorrect.
The addressee's language is incorrect.
The printing type has not been sent
The printing type is incorrect
The sender's last name has not been sent
The sender's first name has not been sent
The sender's email has not been sent
The sender's email is incorrect
The sender's phone number is incorrect
The addressee's landline phone number is
incorrect
The addressee's company name has not been
sent
The size of the AddresseeParcelRef parameter is
zero or greater than 15
The sender's number / street name has not been
sent
The sender's country code has not been sent
The sender's country code is incorrect
The sender's city has not been sent
The sender's postcode has not been sent
The sender's postcode is incorrect
The sender's postcode does not match the country
The sender's country code or the postcode is
27
Code
Type
30200
30202
30204
ERROR
ERROR
ERROR
30206
30207
30208
30210
30211
30212
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
30213
ERROR
30220
30221
30222
30300
30301
30303
30306
30309
30310
30311
30312
30313
30316
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
30317
30318
ERROR
ERROR
30321
30323
30324
30325
30326
ERROR
ERROR
ERROR
ERROR
ERROR
30327
30400
30401
30500
ERROR
ERROR
ERROR
ERROR
30503
30504
30505
ERROR
ERROR
ERROR
30506
30507
ERROR
ERROR
30510
30511
30512
30513
30514
ERROR
ERROR
ERROR
ERROR
ERROR
Comment
incorrect for the product code provided
The addressee's name has not been sent
The addressee's first name has not been sent
The addressee's number / street name has not
been sent
The addressee's country code has not been sent
The addressee's country code is incorrect
The addressee's city has not been sent
The addressee's postcode has not been sent
The addressee's postcode is incorrect
The addressee's postcode does not match the
country
The addressee's country code or the postcode is
incorrect for the product code provided
The addressee's mobile number has not been sent
The addressee's mobile number is incorrect
The addressee's email address has not been sent
The parcel weight has not been sent
The parcel weight is incorrect
The value of the bulky parcel field is incorrect
The registered item option is incorrect
The insured value option is incorrect
The registered item level has not been sent
The registered item level is incorrect
The options do not enable labelling
The product code synonym is empty
The country code does not allow labelling to be
performed
The options do not enable labelling
The XXX partner does not handle the YYY product
code
XXX: partner returned by the routing
YYY: input product code passed to the web service
The parcel number is incorrect
The return choice type has not been sent
The return choice type is incorrect
The advice of receipt option is incorrect
The Free of customs taxes and duty option is
incorrect
The parcel number has not been sent
The pick-up location code has not been sent
The pick-up location code is incorrect
Information about the parcel contents has not been
sent
The parcel category has not been sent
The parcel category is incorrect
Information about the articles contained in the
parcel has not been sent
There are more than the maximum
The total weight of the articles is greater than the
parcel weight
The description of an article has not been sent
The description of an article is incorrect
The quantity of an article has not been sent
The quantity of an article is incorrect
The weight of an article has not been sent
28
Code
30515
30516
30517
30518
30519
30520
30521
30600
Type
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
30700
ERROR
30701
30702
ERROR
ERROR
30703
ERROR
30704
30705
30800
30801
ERROR
ERROR
ERROR
ERROR
ERROR
30802
ERROR
30803
ERROR
30804
ERROR
30805
ERROR
30806
30807
ERROR
30808
ERROR
30809
ERROR
30810
ERROR
30811
30812
ERROR
ERROR
Comment
The weight of an article is incorrect
The value of an article has not been sent
The value of an article is incorrect
The pricing number has not been sent
The pricing number of an article is incorrect
The country of origin has not been sent
The country of origin of an article is incorrect
The {0} field contains a non-valid {1} character.
Please enter this field again.
{0}: Field name
{1}: forbidden characters
The requested product does not exist in the
customer account
The range of parcel numbers used is incorrect
This parcel number has already been allocated to
a parcel less than 13 months ago
The presence or absence of a range indication
does not comply with the subscribed solution.
The product transmitted does not allow a return
service from other countries to be performed.
The country transmitted does not have authority to
offer the return service to other countries.
Please enable the mailbox deposit in your Back
Office
Non-existent parcel
The parcel has not been announced to La Poste.
This parcel has already been accepted into the
system
This parcel has already been accepted into the
system by La Poste
You have already chosen a time
A request has already been made to collect it from
a mailbox
The return product cannot be deposited in a
mailbox
The Mailbox deposit service is not available
This parcel cannot be deposited in a mailbox
The address does not allow a request to be made
for pick-up of parcels from a mailbox
The requested pick-up date is incorrect
The requested pick-up date is not part of the next
possible pick-ups dates from this address
The parcel is not authorised for deposit in a
mailbox
Invalid pick-up date: you have not activated
mailbox deposit in your Back Office
Please do not indicate a pick-up date if you have
chosen the option: label non-depositable in a
mailbox
Invalid mailbox pick-up request: parcel nondepositable in a mailbox
The requested pick-up date is incorrect
No pick-up date found for this address
This address is not eligible for pick-up of a return
parcel left in a mailbox
29
Code
40011
Type
ERROR
40012
ERROR
40013
ERROR
40014
ERROR
40015
ERROR
International shipment errors
ROUTING_1
ERROR
ROUTING_2
ERROR
ROUTING_3
ERROR
ROUTING_4
ERROR
ROUTING_5
ERROR
ROUTING_6
ERROR
ROUTING_7
ERROR
ROUTING_8
ERROR
ROUTING_9
ROUTING_0
ERROR
ERROR
ROUTING_12
ROUTING_13
ERROR
ERROR
ROUTING_14
ROUTING_15
ROUTING_16
ERROR
ERROR
ERROR
ROUTING_17
ERROR
ROUTING_18
ROUTING_19
ROUTING_20
ROUTING_21
ROUTING_22
ROUTING_23
ROUTING_24
ROUTING_25
ROUTING_26
ROUTING_27
ROUTING_200
ROUTING_201
ROUTING_202
ROUTING_203
ROUTING_204
ROUTING_205
ROUTING_206
ROUTING_207
ROUTING_208
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
ERROR
Comment
Error: country of destination code of the parcel
incorrect
Error: Country not covered by the Retour
Colissimo International service or incorrect.
Contact your customer support
Error: Sender country and country of destination
relation not covered or incorrect. Contact your
customer support
Error: Set of parcel identification numbers
exhausted. Contact your customer support
Service temporarily unavailable
The service is not in the database.
The country is not in the database.
The depot is not in the database.
The send date format is invalid.
The format of the postcode entered does not
correspond to the country postcode mask.
The postcode entered is not between the country's
lower / upper limits.
The limit values of the postcode for the city and
region have not been entered.
The postcode does not match the input data of the
region / city.
The postcode of the country does not exist.
The postcode of the area and the city does not
exist.
The group associated with this site does not exist.
The address associated with the site does not
exist.
There is no country associated with the site.
The customs re-routing does not exist.
The depot code is mandatory. Please enter a
value.
The country code is mandatory. Please enter a
value.
There is no route for these data.
There are several routes for these data.
This option is not allowed for this route.
The data entered do not allow this option.
The option is mandatory. Please enter a value.
The request has failed.
The request has failed. The connection is down.
The request has failed. The connection is down.
The country of origin does not exist.
The country of destination does not exist.
The Fedex route for this country is suspended.
This country is under embargo.
This country code is obsolete.
This country is not managed by Fedex.
The Fedex route has not been found.
The Fedex bar code has not been found.
The Fedex unloading function has not been found.
The Fedex file has not been found.
More than one Postcode / Site combination are
necessary for manual routing.
30
Code
ROUTING_211
Type
ERROR
ROUTING_212
ROUTING_300
ROUTING_301
ERROR
ERROR
ERROR
ROUTING_302
ERROR
ROUTING_305
ERROR
ROUTING_1005
ROUTING_1006
ERROR
ERROR
ROUTING_1007
ROUTING_1008
ERROR
ERROR
ROUTING_1100
ERROR
Comment
The Fedex programming interface cannot be
loaded.
The programming interface has returned an error.
The initialisation of the TNT component has failed.
There is no TNT product associated with this
Geopost product.
There is no destination site associated with this
Geopost site.
There is no origin site associated with this Geopost
site.
The routing initialisation could not be opened.
The routing initialisation file does not contain the
mandatory tag.
The SQLite DLL cannot be loaded.
The connection to the database could not be
initialised.
CAUTION: The database has expired, and there is
no valid replacement database available.
Where the SOAP request does not respect the xsd defined in the wsdl, the Framework axis
return an error in the response:
Case 1: Invalid date
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: 2x015-03/23</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>
Case 2: Invalid boolean
<soap:Body>
<soap:Fault>
<faultstring>Unmarshalling Error: cvc-datatype-valid.1.2.1: 'eeee' is not a valid value for
'boolean'.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>
Case 3: Mandatory information not supplied:
<soap:Body>
<soap:Fault>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.a: Invalid content was found
starting with element 'city'. One of '{zipCode}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>
31
VI. Annex 2: printed materials
VI.1 Display of data on the labels
The data sent to the Web Service are not all displayed on the label generated.
They can also be cut if space is lacking on the label, but a cut data item remains sent in full in
the information system of La Poste Colissimo.
The amount of cutting of the data varies depending on the printing formats (thermal or office)
or according to our products.
VI.2 Right side of the label (A4 format only)
The right part of the freight list is used as the communication space between the e-retailer
and its customer. It is composed of 3 parts:
Elements of the label may change.
Description of the areas:
1. Space for "Colissimo" logo: for So Colissimo solutions with certificate of posting and
Retour Colissimo, this logo can be customised from the corporate space on the website
(Espace Entreprises).
2. Instructions for use of the label: for the Retour Colissimo solution, the contents of this
block varies depending on the delivery options (see below)
3. Certificate of posting: summary to be stamped by La Poste on depositing the parcel
32
For the Retour Colissimo solution, block #2 varies depending on the delivery options:
Model 1 - For deposit in a post office or in a store
This slip is issued by La Poste if the address of the sender does not allow access to the
shipment service from their personal mailbox.
○,1
After having cut-out the label following the dotted lines, place it flat on your parcel.
○,2
Then affix it using sticky tape making sure not to cover the information and the barcode.
○,3
Deposit your parcel in a post office or in a store which is part of the La Poste network (max 20kg). Choose the
nearest posting location to you on www.colissimo.fr/retour*.
*Free consultation excluding connection
charges.
How to use your RETOUR Colissimo label?
Track the delivery of your parcel on www.colissimo.fr*
Model 2 - For deposit in a post office or a store or in a mailbox (pick-up date
not chosen)
This slip is issued by La Poste if the address of the sender allows access to the shipment
service from their personal mailbox.
Cut-out the label following the dotted lines, place it flat on your parcel. Affix it using sticky tape making sure
○,1not to cover the information and the barcode.
Choose to post your parcel:
○,2
- In your mailbox before 8 a.m. Make a request on www.colissimo.fr/retourbar*
- At a post office (max 30kg)
- At a store of the La Poste network (max 20kg). List of posting locations on
Track the delivery of your parcel on www.colissimo.fr*
○,3
charges.
The Retour Colissimo label allows you to return your parcel with paying postage.
Model 3 - For a deposit with request for pick-up from a mailbox (chosen date)
This slip is issued by La Poste if the address of the sender allows them access to the personal
mailbox shipment service and if the e-retailer has included the request for pick-up from a
mailbox on its e-commerce website.
The parcel pick-up date from the mailbox is then indicated on the right side of the slip
33
the label following the dotted lines, place it flat on your parcel. Affix it using sticky tape making sure
○,1Cut-out
not to cover the information and the barcode.
○,2You have chosen to send your parcel from your mailbox:
- Your parcel must be in your mailbox:
on 20/03/2015 before 9 a.m. so that the parcel postman collects it during the day.
- He will then deposit a collection advice in your mailbox.
○,3Track the delivery of your parcel on www.colissimo.fr*
charges.
The Retour Colissimo label allows you to return your parcel with paying postage.
Each parcel delivery must be accompanied with a freight list summarising the information
listed in the following paragraphs.
VI.3 Freight List Model
SITE DE PRISE EN CHARGE : XXXXXX
LIBELLE SITE DE PRISE EN CHARGE : XXXXXXXXXXXXXXX
N° CLIENT
:
BORDEREAU DE REMISE Offre Entreprises Colissimo
XXXXXX
EDITE LE JJ/MM/AAAA
LIBELLE CLIENT
:
NOM CLIENT
N° BORDEREAU
:
0000000001 DU JJ/MM/AAAA
Réf. exped
Nom et Adresse destinataire
N° colis
CPOST
CPAYS
Poids
(KG)
NM
XXXXX
IT
01.00
0
COLISSIMO EXPERT INTER - compte de facturation : XXXXXX
xxxxxxxxxxxx
XXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXX
SIGNATURE DE L’AGENT (*)
NOMBRE DE COLIS DE LA PAGE
POIDS DES COLIS DE LA PAGE
: XX
: XX
NOMBRE TOTAL DE COLIS
POID TOTAL DE COLIS
: XX
: XX
DATE
* Cette signature ne vaut pas validation
des données indiquées par le client
Nombre de page : 1
Page n°1
34
VI.4 Contents of the list
Document title
Site Prise en charge :
Libellé site de prise en
charge :
N° Bordereau :
Date :
N° Client :
Réf. expéditeur:
"Bordereau de remise Offre Entreprises Colissimo"
(Freight list)
Identification code of the injection hub (6 numeric characters)
allocated to the customer
Plain text wording of the injection hub (40 char. alphabetical),
provided by the sales contact
Sequence number of the freight list (this number must be
continuous) (10 numeric characters)
List issue date: List issue date (DD/MM/YYYY).
This date is considered by La Poste - Colissimo as being the date
of the physical deposit of the parcels
Important: this date must correspond to the actual date of the
physical deposit of the parcels at the injection hub.
Customer number supplied by La Poste - Colissimo over 6
characters
ID of the shipment of this parcel in your own system (if you wish)
[35 alphanumeric characters].
Nom et Adresse
destinataire :
Name and Address of the addressee (if required)
N° Colis :
Complete parcel tracking number sorted in ascending order
CPOST
Postcode
CPAYS
Country code
Poids :
Weight of the parcel in kg (< or = 30 kg)
NB:
Block set to "1" if the parcel is not machinable, "0" if machinable
Nombre de colis de la page Total number of parcels listed in the page
Poids des colis de la page
Nombre Total de colis
Poids total des colis
Nombre de pages
ZONE RESERVEE
Page :
Total weight of parcels listed in the page
Total number of parcels in the freight list and deposited with La
Poste - Colissimo.
Total weight of parcels in the freight list and deposited with La
Poste - Colissimo.
Total number of pages making up the freight list
Reserve a block for the signature by the La Poste - Colissimo
agent and the Date Stamp.
Number of the current page out of the total number of pages, or
page number with "dernière page" (last page) wording on the last
page.
Comment:
The freight list is needed for destinations needing a CN23 only.
The customer can publish it via its own means or via the Back-Office if the option
has been requested from your sales contact (only for So Colissimo products).
35
VII.
Annex 3: Examples of SOAP envelopes
VII.1 getProductInter Method
XML input request using the getProductInter method
<sls:getProductInter>
<getProductInterRequest>
<contractNumber>800148</contractNumber>
<password>PWD991</password>
<productCode>COLI</productCode>
<insurance>0</insurance>
<nonMachinable>0</nonMachinable>
<returnReceipt>0</returnReceipt>
<countryCode>DZ</countryCode>
<zipCode>2000</zipCode>
</getProductInterRequest>
</sls:getProductInter>
XML output response from the getProductInter method
<return>
<messages>
<id>0</id>
<type>INFO</type>
</messages>
<product>CP</product>
<partnerType>1</partnerType>
<returnTypeChoice>2</returnTypeChoice>
</return>
VII.2 generateLabel Method
Input XML request:
<sls:generateLabel>
<generateLabelRequest>
<password>PWD991</password>
<outputFormat>
<x>0</x>
<y>0</y>
<outputPrintingType>PDF_A4_300dpi</outputPrintingType>
<returnType></returnType>
</outputFormat>
36
<letter>
<service>
<productCode>A2P</productCode>
<depositDate>2015-12-23</depositDate>
<mailBoxPicking>false</mailBoxPicking>
<transportationAmount>1040</transportationAmount>
<totalAmount>1222</totalAmount>
<orderNumber>123456</orderNumber>
<commercialName>MONSITE.COM</commercialName>
</service>
<parcel>
<weight>1</weight>
<nonMachinable>false</nonMachinable>
<instructions>REMETTRE AU GARDIEN</instructions>
<pickupLocationId>005737</pickupLocationId>
</parcel>
<customsDeclarations>
<includeCustomsDeclarations>1</includeCustomsDeclarations>
<contents>
<article>
<description>desc</description>
<quantity>1</quantity>
<weight>1</weight>
<value>12</value>
<hsCode>0102</hsCode>
<originCountry>FR</originCountry>
</article>
<category>
<value>2</value>
</category>
</contents>
</customsDeclarations>
<sender>
<senderParcelRef>refsenderXXX</senderParcelRef>
<address>
<companyName>sender company</companyName>
<lastName>dupont</lastName>
<firstName>fred</firstName>
<line0>etage</line0>
<line1>entrée</line1>
<line2>ligne principale</line2>
<line3>lieu dit</line3>
<countryCode>FR</countryCode>
<city>paris</city>
<phoneNumber>0123456789</phoneNumber>
<mobileNumber>0677777777</mobileNumber>
<doorCode1>12ZZ2</doorCode1>
<doorCode2>121FD</doorCode2>
<email>[email protected]</email>
<intercom>99009</intercom>
37
<language>FR</language>
</address>
</sender>
<addressee>
<addresseeParcelRef>12345</addresseeParcelRef>
<codeBarForReference>false</codeBarForReference>
<serviceInfo>service info</serviceInfo>
<promotionCode></promotionCode>
<address>
<companyName>comp dest</companyName>
<lastName>martin</lastName>
<firstName>alain</firstName>
<line0>etage</line0>
<line1>entree</line1>
<line2>adresse</line2>
<line3>lieu dit</line3>
<city>paris</city>
<phoneNumber>0133223345</phoneNumber>
<mobileNumber>0623456789</mobileNumber>
<doorCode1>3454</doorCode1>
<doorCode2>ZA22</doorCode2>
<intercom>324RR</intercom>
<language>FR</language>
</address>
</addressee>
</letter>
</generateLabelRequest>
</sls:generateLabel>
XML response:
A URL link to the PDF is returned
<return>
<messages>
<id>0</id>
<messageContent>Your request was successfully
processed</messageContent>
<type>INFO</type>
</messages>
<labelResponse>
<label>MTQgMCBvYmoKPMTQgMCBvYmoKP..
<parcelNumber>6M00014522109</parcelNumber>
<pdfUrl>http://ws.colissimo.fr/xxx/shippingclpV3/GetLabel?parcelNumber=
6M00014522109&signature=099a6ac2f294a103db409fcd248fd8bb3b75e3d9c1f76d31996276b4d2
ce87d5&includeCustomsDeclarations=false</pdfUrl>
</labelResponse>
</return>
38
VII.3 getListMailBoxPickingDates Method
XML input request using the getListMailBoxPickingDates method
<getListMailBoxPickingDatesRetourRequest>
<password>ABCDEF</password>
<sender>

<line0></line0>

<line1></line1>

<line2>12 rue des fleurs</line2>

<line3></line3>


<city>PARIS</city>
</sender>
</getListMailBoxPickingDatesRetourRequest>
Exit XML request for getListMailBoxPickingDates method
<getListMailBoxPickingDatesRequest>
<messages>
<id>0</id>
<type>INFO</type>
</messages>
<mailBoxPickingDateMaxHour>08:00</mailBoxPickingDateMaxHour>
<mailBoxPickingDates>2015-02-18T00:00:00+01:00</mailBoxPickingDates>
<mailBoxPickingDates>2015-02-19T00:00:00+01:00</mailBoxPickingDates>
<validityTime>23:00</validityTime>
</getListMailBoxPickingDatesRequest>
VII.4 planPickup Method
XML input request using the planPickup method
<sls:pickMailBoxing>

<arg0>
<password>ABCDEF</password>
<parcelNumber>8R99999999999</parcelNumber>

39
<mailBoxPickingDate>2015-02-18</mailBoxPickingDate>
<sender>

<companyName></companyName>

<lastName>DUPONT</lastName>

<firstName>Albert</firstName>

<line0></line0>

<line1></line1>

<line2>12 rue des plantes</line2>

<line3></line3>

<city>PARIS</city>



<phoneNumber></phoneNumber>
</sender>
<arg0>
</sls:pickMailBoxing>
Output XML response of the planPickup method
<ns2:pickMailBoxingResponse xmlns:ns2="http://sls.ws.coliposte.fr">
<pickMailBoxingRequest>
<messages>
<id>0</id>
<type>INFO</type>
</messages>
</pickMailBoxingRequest>
</ns2:pickMailBoxingResponse>
40

DT_Flexibilite_Expedition_Web Service - Colissimo

Transcription

Documents pareils

exclusive - DIRECT SUCCESS GmbH

global vice president of channel sales

chateau les hautes tuileries

Returns Form

Lady purse Bagatelle Bordeaux - Boutique cadeaux d`affaires Axxo

Head Network Assurance Airtel Tchad recherche des

Job Description

Economies of Scope in Delivering Parcels and Letters Together

Project Manager