Octopia Delivery Modes – Octopia API documentation

Octopia is undergoing a large transition from its legacy APIs to standard REST APIs.

For reference on Legacy APIs see SOAP API Deprecation

During this transition, some APIs provide different data sets for a single element, this is typically the case when handling delivery Modes

Main Octopia Delivery Modes

Octopia provides a base set of delivery modes as follows :

Small parcels

Code	Label
THD	TrackedHomeDelivery
SHD	SignedHomeDelivery
EHD	ExpressHomeDelivery

Large parcels

Code	Label
FDHD	FixedDateHomeDelivery
SRHD	SpecificRoomHomeDelivery
WSHD	WithSetupHomeDelivery

Extended Delivery Modes and Legacy matching

Based on your activities on our platform and your active subscriptions other deliverymodes can be returned or submitted.

Please see below the table for additional details.

Mode	Code	Label	Legacy⁽¹⁾ Mode	XML OfferPackage	SalesChannel availability⁽²⁾	OSP Name (FR)	OSP Name (EN)	OSP Name (ES)
M30 (<30kg)	`NTHD`	`NotTrackedHomeDelivery`	`STD`	`Standard`	Cdiscount	Normal	Standard	Estándar
M30 (<30kg)	`THD`	`TrackedHomeDelivery`	`TRK`	`Tracked`	All (mandatory)	Suivi	Tracked	Seguimiento
M30 (<30kg)	`SHD`	`SignedHomeDelivery`	`REG`	`Registered`	When active*	Recommandé	Registered	Certificado
M30 (<30kg)	`EHD`	`ExpressHomeDelivery`	`EXP`	`Express`	When active*	Express	Express	Express
P30	`FDHD`	`FixedDateHomeDelivery`	`LV1`	`BigParcelEco`	When active*	Eco (devant chez vous)	At home	Al frente del domicilio
P30	`SRHD`	`SpecificRoomHomeDelivery`	`LV2`	`BigParcelStandard`	When active*	Standard (chez vous)	Usual (in home)	En el domicilio
P30	`WSHD`	`WithSetupHomeDelivery`	`LV3`	`BigParcelComfort`	When active*	Confort (installation)	Comfort (installed)	Instalación en el domicilio
ShopPickup	–	`ImmediateVendorPickup`	`RIM`	`Rim`	Cdiscount	Retrait immédiat en magasin	Immediate pickup at store	Retirada inmediata en la tienda
ShopPickup	–	`VendorPickup`	`MAG`	`Relay`	Cdiscount	En magasin	Store delivery	En tienda
PickupPoint	`PPMR`	`PickupPointMondialRelay`	`REL`	`MondialRelay`	Cdiscount	Mondial Relay	Mondial Relay	Mondial Relay
PickupPoint	`PPRC`	`PickupPointRelaisColis`	`RCO`	`RelaisColis`	Cdiscount	Relais Colis	Relais Colis	Relais Colis
PickupPoint	`PPLP`	`PickupPointLaPoste`	`SO1`	`SoColissimo`	Cdiscount	So Colissimo	So Colissimo	So Colissimo

Footnotes :
* : depends on SalesChannel choice for enabled delivery modes
(1) : These delivery codes are used in the legacy SOAP API
(2) : Delivery modes marked as “Cdiscount” are only available on the CDISFR salesChannel, offers with such delivery modes will not be published on other salesChannels

All values are case sensitive

JSON Representation

[
   {
      "label":"NotTrackedHomeDelivery",
      "shortcode":"NTHD",
      "legacyModeCode":"STD",
      "legacyModeLabel":"Standard",
      "type":"SmallParcel",
      "readable":{
         "FR":"Normal",
         "EN":"Standard",
         "ES":"Estándar"
      }
   },
   {
      "label":"TrackedHomeDelivery",
      "shortcode":"THD",
      "legacyModeCode":"TRK",
      "legacyModeLabel":"Tracked",
      "type":"SmallParcel",
      "readable":{
         "FR":"Suivi",
         "EN":"Tracked",
         "ES":"Seguimiento"
      }
   },
   {
      "label":"SignedHomeDelivery",
      "shortcode":"SHD",
      "legacyModeCode":"REG",
      "legacyModeLabel":"Registered",
      "type":"SmallParcel",
      "readable":{
         "FR":"Recommandé",
         "EN":"Registered",
         "ES":"Certificado"
      }
   },
   {
      "label":"ExpressHomeDelivery",
      "shortcode":"EHD",
      "legacyModeCode":"EXP",
      "legacyModeLabel":"Express",
      "type":"SmallParcel",
      "readable":{
         "FR":"Express",
         "EN":"Express",
         "ES":"Express"
      }
   },
   {
      "label":"FixedDateHomeDelivery",
      "shortcode":"FDHD",
      "legacyModeCode":"LV1",
      "legacyModeLabel":"BigParcelEco",
      "type":"LargeParcel",
      "readable":{
         "FR":"Eco (devant chez vous)",
         "EN":"At home",
         "ES":"Al frente del domicilio"
      }
   },
   {
      "label":"SpecificRoomHomeDelivery",
      "shortcode":"SRHD",
      "legacyModeCode":"LV2",
      "legacyModeLabel":"BigParcelStandard",
      "type":"LargeParcel",
      "readable":{
         "FR":"Standard (chez vous)",
         "EN":"Usual (in home)",
         "ES":"En el domicilio"
      }
   },
   {
      "label":"WithSetupHomeDelivery",
      "shortcode":"WSHD",
      "legacyModeCode":"LV3",
      "legacyModeLabel":"BigParcelComfort",
      "type":"LargeParcel",
      "readable":{
         "FR":"Confort (installation)",
         "EN":"Comfort (installed)",
         "ES":"Instalación en el domicilio"
      }
   },
   {
      "label":"ImmediateVendorPickup",
      "shortcode":"",
      "legacyModeCode":"RIM",
      "legacyModeLabel":"Rim",
      "type":"Shop",
      "readable":{
         "FR":"Retrait immédiat en magasin",
         "EN":"Immediate pickup at store",
         "ES":"Retirada inmediata en la tienda"
      }
   },
   {
      "label":"VendorPickup",
      "shortcode":"",
      "legacyModeCode":"MAG",
      "legacyModeLabel":"Relay",
      "type":"Shop",
      "readable":{
         "FR":"En magasin",
         "EN":"Store delivery",
         "ES":"En tienda"
      }
   },
   {
      "label":"PickupPointMondialRelay",
      "shortcode":"PPMR",
      "legacyModeCode":"REL",
      "legacyModeLabel":"MondialRelay",
      "type":"Relay ",
      "readable":{
         "FR":"Mondial Relay",
         "EN":"Mondial Relay",
         "ES":"Mondial Relay"
      }
   },
   {
      "label":"PickupPointRelaisColis",
      "shortcode":"PPRC",
      "legacyModeCode":"RCO",
      "legacyModeLabel":"RelaisColis",
      "type":"Relay ",
      "readable":{
         "FR":"Relais Colis",
         "EN":"Relais Colis",
         "ES":"Relais Colis"
      }
   },
   {
      "label":"PickupPointLaPoste",
      "shortcode":"PPLP",
      "legacyModeCode":"SO1",
      "legacyModeLabel":"SoColissimo",
      "type":"Relay ",
      "readable":{
         "FR":"So Colissimo",
         "EN":"So Colissimo",
         "ES":"So Colissimo"
      }
   }
]

Other modes :

Depending on your activity within the Octopia network and the complexity of your fulfillment management with our services, other delivery modes can be read from the GET /orders endpoint.

Previously available modes, which are currently considered obsolete are not given in this mapping table.

Columns explanations

Octopia – Code

Octopia Code is the delivery mode short code range, available through APIs exposing the “code” or “mode” attribute

Offer Endpoint

GET /offers

/* items[].deliveryOffers[] */
"deliveryModes": [
            {
              /* other information */
              "code": "THD"
            }
          ]

Fulfillment Endpoint

GET /outbound-shipments

/* items[] */
"delivery": [
            {
              "mode": "THD"
              /* other information */
            }
          ]

It is also the required value when submitting data through

POST /offer-requests (please note that submitting offers with this endpoint does not publish towards Cdiscount)
POST /outbound-shipments

Octopia – Label

The delivery mode attribute “label” or “mode” is available through the following APIs :

Orders Endpoint

GET /orders

/* items[].lines[] */
"delivery": [
            {
              "mode": "TrackedHomeDelivery"
              /* other information */
            }
          ]

Please note that PickupPoint delivery modes also expose pickupIp and pickupName within shippingAddresses nodes.

LegacyMode

The delivery mode attribute “ModLiv” was available through the following APIs :

SOAP – GetOrderList

It is provided here as a reference mapper for legacy integrations and should not be used anymore. See also SOAP API Deprecation

XMLOfferPackage

These values are to be used in XML offer publication packages under the OfferShippingInformationList node as an “DeliveryMode” attribute to ShippingInformation.

XML Offers Endpoint

POST /offer-integration-packages

<Offer.ShippingInformationList>
	<ShippingInformationList Capacity="3">
		<ShippingInformation 
			DeliveryMode="Tracked"
			ShippingCharges="0.00" 
			AdditionalShippingCharges="0.00"
		/>
	</ShippingInformationList>			</Offer.ShippingInformationList>

SalesChannel Availability

Some delivery modes are currently required whichever the targetted publication channel or offer publication method

Others can only be submitted to specific sales channels.

All sales channels can accept or not your offers based on which delivery methods you provide.

OSP Name (language code)

This is how it is currently displayed within your seller portal.