Functional documentation
Offer feature V2
How to manage your catalog
API offer Feature
The offer allows you to manage your catalog. With the offer feature, you will be able to :
- Manage CDISCOUNT catalog but also Octopia sales channels
- Create and update your offer information
- Check your offer integration log
- Set up commercial operations (Cdiscount only)
What is an offer ?
In order to understand what “offer” means for Octopia you can read the help center documentation. You will find :
- The difference between product and offer
- How to create and update offers via API
- How to delete an offer (not with API)
- How to apply commercial operations (only Cdiscount)
List of offer information submitted by seller
SellerExternalReference
| FIELD DESCRIPTION | This reference is the identifier that you give to your offers. |
| EXPECTED FORMAT | Alphanumeric |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | Between 1 and 50 characters |
| CHARACTER | Mandatory |
| Business rules | This field cannot be empty.Several offers on the same sales channel cannot have the same reference.Allowed special characters: “{ }”, “@”, “%”, “;”, “$”, “=”, “[]”, “/”, “,”, “-“, “()” , ” ‘ “, “\”, ” ” “, “&”, “!”, “#”, “^”, “#”, “?”, “_” , “+” , “:” , ” .” |
Product GTIN (EAN or GTN)
| FIELD DESCRIPTION | The EAN code (bar code) or GTIN, allowing unique identification of the product. |
| EXPECTED FORMAT | Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 13 characters on CdiscountBetween 8 and 14 characters on Octopia |
| CHARACTER | Mandatory for creation if the seller does not use the product reference used when creating the productOptional for creation if the seller uses the product reference used when creating the productOptional for modifying the offer |
| Business rules | Check the formatting of the 0s at the start of the cell, so that they appear correctly.The EAN must correspond to an existing product at Cdiscount or Octopia .( Octopia ) The product must be sellable |
Condition
| FIELD DESCRIPTION | The product condition allows to qualify the state of the product. To be chosen from the values in the limited list, depending on the condition of the product. | |
| EXPECTED FORMAT | Bounded list | |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | ||
| CHARACTER | Mandatory (not case sensitive) | |
| Business rules | Please note, in the case of submission by excel matrix, the expected value of the list depends on the language in which the matrix was generated (Example: If generated in English, the value Neuf – Neuf will become New – New) | |
| Enum (productCondition) | Wording | |
| LikeNew (1) | Used – Like new | |
| VeryGoodState (2) | Used – Very good state | |
| AverageState (4) | Used – Average state | |
| New (6) | New – New | |
| RefurbishedLikeNew (7) | Refurbished – Like new | |
| RefurbishedVeryGoodState (8) | Refurbished – Very good state | |
| RefurbishedCorrectState (9) | Refurbished – Good state | |
Quantity (Stock)
| FIELD DESCRIPTION | Number of units that you put up for sale on the offer on a sales channel A zero stock does not allow the offer to be published on Cdiscount or Octopia . If you subscribe to Fulfillment On Demand , this field allows you to declare the stock you are hosting. |
| EXPECTED FORMAT | Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | Between 1 and 10 characters |
| CHARACTER | Mandatory |
| Business rules | The field value must be less than 10,000,000,000.For the same seller, on the same product and the same condition, quantity is shared across all sales channels (Cdiscount and Octopia )If a decimal place is indicated in this field, it is rounded to the whole |
Price
| FIELD DESCRIPTION | Price to be informed including tax, excluding shipping costs, including Eco share and DEA if applicable, expressed in €. |
| EXPECTED FORMAT | Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 10 characters before the decimal point, 2 characters after |
| CHARACTER | Mandatory |
| Business rules | The price must be greater than 0.00 (Currency).The price must be greater than the sum of the EcoTax and DeaTax fields.The price must be higher than the floor price.The price must be lower than the Origin (or Striked) price. |
OriginPrice
| FIELD DESCRIPTION | Market price observed for the product. Also called Striked Price |
| EXPECTED FORMAT | Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 10 characters before the decimal point, 2 characters after |
| CHARACTER | Optional |
| Business rules | This price must be strictly greater than the Price field. |
Taxes
| FIELD DESCRIPTION | The list of the taxes applied on offers. For Update packages, the complete list of taxes must be expressed |
| EXPECTED FORMAT | Object |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | Array of taxesList of available taxes : LISTE A DEMANDER A LA FINANCE |
| CHARACTER | Mandatory |
| Business rules | The taxes object is mandatory Each objects in the array must have variables “code” and “value” and the associated values The Array can be empty if there is no taxes to apply on this sales channel |
VAT
| FIELD DESCRIPTION | VAT rate applicable to the product, expressed in % |
| EXPECTED FORMAT | code : Stringvalue : Digital (ex : 0.2 for 20% of VAT) |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | For the value :4 characters before comma, 2 characters after |
| CHARACTER | Mandatory |
| Business rules | The VAT field cannot be strictly greater than 100%.The sum of taxes must be strictly lower than the price and floor price |
EcoTax
| FIELD DESCRIPTION | Eco-participation applicable to new products. Even if the tax is not applicable to this product, you must fill the field with the value zero. |
| EXPECTED FORMAT | code : Stringvalue : Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 3 characters before comma, 2 characters after |
| CHARACTER | Mandatory |
| Business rules | The EcoTax field must be strictly less than 1000.The sum of taxes must be strictly lower than the price and floor price |
DEATax
| FIELD DESCRIPTION | Eco-furnishing applicable to furnishing goods Even if the tax is not applicable to this product, you must fill in the field with the value zero. |
| EXPECTED FORMAT | code : Stringvalue : Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 4 characters before comma, 2 characters after |
| CHARACTER | Mandatory |
| Business rules | The DEA field must be strictly less than 1000.The sum of taxes must be strictly lower than the price and floor price |
Private Copy _
| FIELD DESCRIPTION | French tax on information storage and the right to private copying |
| EXPECTED FORMAT | code : Stringvalue : Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 4 characters before comma, 2 characters after |
| CHARACTER | Optional |
| Business rules | The Private Copy field must be strictly lower than the price including tax.The sum of taxes must be strictly lower than the price and floor price |
Chemical Tax
| FIELD DESCRIPTION | Swedish chemical tax |
| EXPECTED FORMAT | code : Stringvalue : Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 4 characters before comma, 2 characters after |
| CHARACTER | Optional |
| Business rules | Tax field must be strictly lower than the tax-inclusive price.The sum of taxes must be strictly lower than the price and floor price |
Delivery Modes
| FIELD DESCRIPTION | The list of delivery modes to be applied on offers. For Update packages, the complete list of delivery modes must be expressed |
| EXPECTED FORMAT | Object |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | Array of delivery modes code: String cost: Digital additionalCost: DigitalCombined with the preparationTime fieldExample:”deliveryModes”: [ { “code”: “THD”, “cost”: 0.0, “additionalCost”: 0.0 } |
| CHARACTER | Mandatory |
| Business rules | The Delivery Modes object is mandatory Each objects in the array must have variables “code” “cost” and “additionalCost” (optional) and the associated values |
Delivery modes code
| FIELD DESCRIPTION | The delivery mode code is a list of available delivery modes that can be set for each offer. |
| EXPECTED FORMAT | string |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | |
| CHARACTER | MandatoryList of available delivery modes for Octopia sales channels Code – Definition THD – TrackedHomeDelivery EHD – ExpressHomeDelivery SHD – SignedHomeDelivery FDHD – FixedDateHomeDelivery SRHD – SpecificRoomHomeDelivery WSHD – WithSetupHomeDelivery PPMR – Mondial Relay SB2B – BtoB |
| Business rules | The delivery mode availability depends on the configuration of the sales channels.If the delivery mode is not configured on the sales channel, an error will be thrown. The offer must have at least one configured delivery mode to be published |
Delivery modes cost
| FIELD DESCRIPTION | Amount of delivery costs |
| EXPECTED FORMAT | Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 10 characters before the decimal point, 2 characters after |
| CHARACTER | Mandatory |
| Business rules | The delivery mode cost must be associated to a delivery mode code |
Delivery modes additional cost
| FIELD DESCRIPTION | Amount of additional delivery costs paid for the 2nd item for customers. If you wish to apply free additional costs, you must put “0” in this field. If the field is not filled, it is automatically set to 0. |
| EXPECTED FORMAT | Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 10 characters before the decimal point, 2 characters after |
| CHARACTER | Optional |
| Business rules | Additional costs cannot be strictly greater than 30 euros.If the field is not filled by the seller, 0 is automatically filled in it. |
Preparation Time
| FIELD DESCRIPTION | Maximum number of working days between your validation of the order and delivery of the package to the carrier. This delay therefore excludes the delay from the carrier to the end customer. |
| EXPECTED FORMAT | Digital |
| FIELD SIZE & MAXIMUM EXPECTED VALUE | 10 characters before the decimal point, 2 characters after |
| CHARACTER | Mandatory |
| Business rules | If a decimal place is indicated in this field, it is rounded to the wholeThe preparation Time is mandatory with the delivey modes for the update packages. |