Detailed Description of the Offers.xml files
Please find hereafter a sample of each offer package format :
- Full : APIMPCdiscount_Sample_Offers_Full
- Stock&Price (or light) : APIMPCdiscount_Sample_Offers_StockAndPrice
- With Sales Channel filter : APIMPCdiscount_Sample_Full_SalesChannels
- With striked Price, Flash Sales and Sales : APIMPCdiscount_Sample_Offers_OPECO
- Hereafter the offers xsd file: XSDOffer.zip
Element OfferPackage
This element describes an offer package.
diagram | ![]() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
namespace | clr-namespace:Cdiscount.Service.OfferIntegration.Pivot;assembly=Cdiscount.Service.OfferIntegration | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties |
| content | complex | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
content | complex | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
children | OfferPackage.OfferPublicationList OfferPackage.Offers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attributes |
| Name | Type | Use | Default | Fixed | annotation | PurgeAndReplace | xs:boolean | Name | xs:string | required
| PackageType | xs :string | optional | Full | Full/StockAndPrice | ||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Use | Default | Fixed | annotation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PurgeAndReplace | xs:boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | xs:string | required
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageType | xs :string | optional | Full | Full/StockAndPrice | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source | <xs:element name=”OfferPackage”>
<xs:complexType> <xs:sequence> <xs:element name=”OfferPackage.OfferPublicationList”> <xs:complexType> </xs:element> <xs:element name=”OfferPackage.Offers”> <xs:complexType> </xs:element> </xs:sequence> <xs:attribute name=”PackageType” type=”xs:string”></xs:attribute> <xs:attribute name=”Name” type=”xs:string”></xs:attribute> <xs:attribute name=”PurgeAndReplace” type=”xs:string”></xs:attribute> </xs:complexType> </xs:element> |
Attribute OfferPackage/@PurgeAndReplace
This attribute indicates if « Purge and Replace » option is selected. It is optional. If not indicated, « Purge and Replace » option is not used, and « Update offers » is the default selection.
The purge will only be applicated on offers on website mentionned in the offerpackage. If there is no website mentionned in the package the purge will be applicated on Cdiscount by default.
type | xs:Boolean | ||||||||
properties |
| isRef | 0 | use | optional | ||||
isRef | 0 | ||||||||
use | optional | ||||||||
source | <xs:attribute name=”PurgeAndReplace” type=”xs:boolean” use=”optional”/> |
Attribute OfferPackage/@Name
This attribute contains the package name. Its presence is informative and needs not to be unique.
type | xs:string | ||||||||
properties |
| isRef | 0 | use | required | ||||
isRef | 0 | ||||||||
use | required | ||||||||
source | <xs:attribute name=”Name” type=”xs:string” use=”required”/> |
Attribute OfferPackage/@PackageType
This attribute contains the package type. It allows to know if it is a normal a full offer update or a light offer update (only Stock and Price updated).
The default value is Full.
If the value is StockAndPrice, only attributes SellerProductId/Ean/Price/Stock are required. Other attributes are ignored.
type | xs:string | ||||||||
properties |
| Kind | Value | enumeration
enumeration | Full
StockAndPrice | ||||
Kind | Value | ||||||||
enumeration
enumeration | Full
StockAndPrice | ||||||||
source | <xs:attribute name=”PackageType” use=”optionnal”> <xs:simpleType> <xs:restriction base=”xs:string”> <xs:enumeration value=”Full”/> <xs:enumeration value=”StockAndPrice”/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Element OfferPackage.OfferPublicationList
This element contains the list of Sales Channels on which offers will be created/updated.
this element is optional, but if it is not mentioned in your file, the website by default is Cdiscount.
If you are not registered on Cdiscount you have to mention this element otherwise all your offers will generate error messages.
diagram | ![]() |
namespace | clr-namespace:Cdiscount.Service.OfferIntegration.Pivot;assembly=Cdiscount.Service.OfferIntegration |
properties | content complex |
children | OfferPublicationList |
used by | element OfferPackage |
attributes | Name Type Use Default Fixed annotation Capacity xs:int |
source | <xs:element name=”OfferPackage.OfferPublicationList”>
<xs:complexType> <xs:sequence> <xs:element name=”OfferPublicationList”> <xs:complexType> <xs:sequence> <xs:element name=”PublicationPool” maxOccurs=”unbounded”> <xs:complexType> <xs:attribute name=”Id” type=”xs:int”/> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name=”Capacity” type=”xs:int”/> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> |
Attribute OfferPublicationList/@PublicationPool
This attributes contains the website Id. You can get the websites Id on which you are registered thanks to the wethod GetSellerInformation.
type | xs:int |
properties | isRef 0 use |
source | <xs:element name=”PublicationPool” maxOccurs=”unbounded”> <xs:complexType> <xs:attribute name=”Id” type=”xs:int”/> </xs:complexType> </xs:element> |
Element OfferPackage.Offers
This element contains an offer list.
diagram | ![]() | ||||
namespace | clr-namespace:Cdiscount.Service.OfferIntegration.Pivot;assembly=Cdiscount.Service.OfferIntegration | ||||
properties |
| content | complex | ||
content | complex | ||||
children | OfferCollection | ||||
used by |
| element | OfferPackage | ||
element | OfferPackage | ||||
source | <xs:element name=”OfferPackage.Offers”> <xs:complexType> <xs:sequence> <xs:element ref=”OfferCollection”/> </xs:sequence> </xs:complexType> </xs:element> |
Element OfferCollection
This element describes an offer list.
diagram | ![]() | ||||||||||||||||||||||||
namespace | clr-namespace:Cdiscount.Service.OfferIntegration.Pivot;assembly=Cdiscount.Service.OfferIntegration | ||||||||||||||||||||||||
properties |
| content | Complex | ||||||||||||||||||||||
content | Complex | ||||||||||||||||||||||||
children | Offer | ||||||||||||||||||||||||
used by |
| element | OfferPackage.Offers | ||||||||||||||||||||||
element | OfferPackage.Offers | ||||||||||||||||||||||||
attributes |
| Name | Type | Use | Default | Fixed | annotation | Capacity | xs:int | ||||||||||||||||
Name | Type | Use | Default | Fixed | annotation | ||||||||||||||||||||
Capacity | xs:int | ||||||||||||||||||||||||
source | <xs:element name=”OfferCollection”> <xs:complexType> <xs:sequence> <xs:element ref=”Offer” maxOccurs=”unbounded”/> </xs:sequence> <xs:attribute name=”Capacity” type=”xs:int” use=”required”/> </xs:complexType> </xs:element> |
Attribute OfferCollection/@Capacity
This attribute contents the offers number in the package.
type | xs:int | ||||||||
properties |
| isRef | 0 | use | |||||
isRef | 0 | ||||||||
use | |||||||||
source | <xs:attribute name=”Capacity” type=”xs:int” use=”required”/> |
Element Offer
This element describes an offer.
diagram | ![]() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
namespace | clr-namespace:Cdiscount.Service.OfferIntegration.Pivot;assembly=Cdiscount.Service.OfferIntegration | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties |
| content | complex | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
content | complex | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used by |
| element | OfferCollection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
element | OfferCollection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Attributes |
| Name | Type | Use | Default | Fixed | annotation | ProductEan | xs :string | Required | SellerProductId | xs :string | Required | ProductCondition | derived by: xs:unsignedByte | Required | Price | xs:decimal | Required | EcoPart | xs:decimal | Required | Vat | xs:decimal | Required | DeaTax | xs:decimal | Required | Stock | xs:int | Required | Comment | xs:string | StrikedPrice | xs:decimal | PriceMustBeAligned | PriceAlignmentAction | MinimumPriceForPriceAlignment | xs:decimal | ProductPackagingUnit | ProductPackagingUnit | ProductPackagingValue | xs :decimal | PreparationTime | xs : byte | Required | BluffDeliveryMax | xs:int | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Use | Default | Fixed | annotation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProductEan | xs :string | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SellerProductId | xs :string | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProductCondition | derived by: xs:unsignedByte | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Price | xs:decimal | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EcoPart | xs:decimal | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Vat | xs:decimal | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DeaTax | xs:decimal | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Stock | xs:int | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comment | xs:string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StrikedPrice | xs:decimal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PriceMustBeAligned | PriceAlignmentAction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MinimumPriceForPriceAlignment | xs:decimal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProductPackagingUnit | ProductPackagingUnit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProductPackagingValue | xs :decimal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PreparationTime | xs : byte | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BluffDeliveryMax | xs:int | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Source |
<?xml version=”1.0″ encoding=”utf-8″?> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Attribute Offer/@ProductEan
This attribute describes the product EAN 13
type | xs:string | ||||||||
properties |
| isRef | 0 | use | required | ||||
isRef | 0 | ||||||||
use | required | ||||||||
source | <xs:attribute name=”ProductEan” type=”xs:string” use=”required”/> | ||||||||
format | 13 figures. Do not forget 0 beginning the figure if inferior to 13 |
Attribute Offer/@SellerProductId
This attribute describes the seller product id
type | xs:string | ||||||||
properties |
| isRef | 0 | use | required | ||||
isRef | 0 | ||||||||
use | required | ||||||||
source | <xs:attribute name=”ProductEan” type=”xs:string” use=”required”/> | ||||||||
format | Alphanumeric, Special characters accepted : – _ / |
Attribute Offer/@ProductCondition
This attribute describes the product condition.
type | restriction of xs:unsignedByte | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties |
|
isRef | 0 | use | required | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isRef | 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
use | required | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
facets |
|
Kind | Value | annotation |
enumeration | 1 | used – excellent condition |
enumeration | 2 | used – very good condition |
enumeration | 4 | used – correct condition |
enumeration | 6 | New – New |
enumeration | 7 | refurbished – excellent condition |
enumeration | 8 | refurbished – very good condition |
enumeration | 9 | refurbished – correct condition |
source | <xs:attribute name=”ProductCondition” use=”required”> <xs:simpleType> <xs:restriction base=”xs:byte”> <xs:enumeration value=”1″/> <xs:enumeration value=”2″/> <xs:enumeration value=”4″/> <xs:enumeration value=”6″/> </xs :enumeration value=”7″/> <xs :enumeration value=”8″/> <xs :enumeration value=”9″/> <x :restriction> </xs:simpleType> </xs:attribute> |
format | A figure ranging from one to six |
Attribute Offer/@Price
This attribute represents the product price, expressed in euros (€).
type | xs:decimal | ||||||||
properties |
| isRef | 0 | use | required | ||||
isRef | 0 | ||||||||
use | required | ||||||||
source | <xs:attribute name=”Price” type=”xs:decimal” use=”required”/> | ||||||||
format | 10 figures maximum including a maximum of 2 for the decimal part |
Attribute Offer/@EcoPart
This attribute represents the product Eco-tax, It is expressed in euros (€).
type | xs:decimal | ||||||||
properties |
| isRef | 0 | use | required | ||||
isRef | 0 | ||||||||
use | required | ||||||||
source | <xs:attribute name=”EcoPart” type=”xs:decimal” use=”required”/> | ||||||||
format | 4 figures maximum including a maximum of 2 for the decimal part |
Attribute Offer/@Vat
This attribute represents the value added Tax of the product, expressed in decimal. Ex : 19.6 stands for a VAT rate 19.6%.
type | xs:decimal | ||||||||
properties |
| isRef | 0 | use | required | ||||
isRef | 0 | ||||||||
use | required | ||||||||
source | <xs:attribute name=”Vat” type=”xs:decimal” use=”required”/> | ||||||||
format | 4 figures maximum including a maximum of 2 for the decimal part |
Attribute Offer/@DeaTax
This attribute represents the Eco-tax on the furniture. It is expressed in euros (€).
type | xs:decimal | ||||||||
properties |
| isRef | 0 | use | required | ||||
isRef | 0 | ||||||||
use | required | ||||||||
source | <xs:attribute name=”DeaTax” type=”xs:decimal” use=”required”/> | ||||||||
format | 4 figures maximum including a maximum of 2 for the decimal part |
Attribute Offer/@Stock
This attribute indicates in stock quantity for this offer.
type | xs:int | ||||||||
properties |
| isRef | 0 | use | required | ||||
isRef | 0 | ||||||||
use | required | ||||||||
source | <xs:attribute name=”Stock” type=”xs:int” use=”required”/> | ||||||||
format | 10 figures maximum |
Atribute Offer/@PriceMustBeAligned
This attribute allows to activate the price alignment. This attribute is optional and the default value is DontAlign.
type | xs:string | ||||||||||||||||||
properties |
| isRef | 0 | ||||||||||||||||
isRef | 0 | ||||||||||||||||||
facets |
| Kind | Value | enumeration
enumeration | Align
DontAlign | ||||||||||||||
Kind | Value | ||||||||||||||||||
enumeration
enumeration | Align
DontAlign | ||||||||||||||||||
source | <xs:attribute name=”PriceMustBeAligned” use=”optionnal”> <xs:simpleType> <xs:restriction base=”xs:string”> <xs:enumeration value=”Align”/> <xs:enumeration value=”DontAlign”/> </xs:restriction> </xs:simpleType> </xs:attribute> |
this attribute is also necessary for the Netotiate functionality. This function allows to the customer to negotiate the price of a product. This functionality must be activated in the seller interface, but even if it is activated, it will be available only on the offers on which the price alignment is activated
Attribute Offer/@MinimumPriceForPriceAlignment
This price is the minimum price in case of price alignment.
type | xs:decimal | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
source | <xs:attribute name=”MinimumPriceForPriceAlignment” type=”xs:decimal”/> | ||||
format | 10 figures maximum including a maximum of 2 for the decimal part |
this attribute is also necessary for the Netotiate functionality. This function allows to the customer to negotiate the price of a product. This functionality must be activated in the seller interface, but even if it is activated, it will be available only on the offers on which the price alignment is activated. The minimu price of the alignement is also the minimum price of the negotiation.
Atribute Offer/@ProductPackagingUnit
This attributes allows to define the unit used to dysplay the unit price (price per liter, per kilo, per square meter or per cubic meter). This attributes is optional and if it is not mentionned, the unit price will not be dysplayed.
type | xs:string | ||||||||||||||||||
properties |
| isRef | 0 | ||||||||||||||||
isRef | 0 | ||||||||||||||||||
facets |
| Kind | Value | enumeration
enumeration enumeration enumeration | Liter
Kilogram SquareMeter CubicMeter | ||||||||||||||
Kind | Value | ||||||||||||||||||
enumeration
enumeration enumeration enumeration | Liter
Kilogram SquareMeter CubicMeter | ||||||||||||||||||
source | <xs:attribute name=”ProductPackagingUnit” use=”optionnal”> <xs:simpleType> <xs:restriction base=”xs:string”> <xs:enumeration value=”Liter”/> <xs:enumeration value=”Kilogram”/> <xs:enumeration value=”SquareMeter”/> <xs:enumeration value=”CubicMeter”/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Attribute Offer/@ProductPackagingValue
This attribute defines the packaged quantity expressed according to the unity(unit).
This value allows to calculate the unit price from the offer price.
type | xs:decimal | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
source | <xs:attribute name=”ProductPackagingValue” type=”xs:decimal”/> | ||||
format | 12 figures maximum including a maximum of 5 for the decimal part |
Attribute Offer/@StrikedPrice
This attribute represents the reference price of the product that will be crossed, This price is expressed in euros
type | xs:decimal | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
source | <xs:attribute name=”StrikedPrice” type=”xs:decimal” /> | ||||
format | 10 chiffres maximum dont 2 maximum pour la partie décimale |
Attribute/@IsCDAV
This attribute allowes to indicate if the offer is eligible to Cdiscount on demand. This feature must have been activated in your sellerzone before.
type | xs:string | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
source | <xs:attribute name=”Comment” type=”xs:string”/> | ||||
format | 200 characters maximum |
Attribute Offer/@Comment
This attribute contents the comment on the offer. It can contain up to 200 characters maximum. It is optional.
type | xs:string | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
source | <xs:attribute name=”Comment” type=”xs:string”/> | ||||
format | 200 characters maximum |
Attribute Offer/@PreparationTime
This attribute describes the number of days to prepare the order. It is the delay between the order acceptation and the order shipment.
this attribute makes useless the attributes MinDeliveryTime, MaxDeliveryTime, MinLeadTime, MaxLeadTime.
These attributes will be automatically estimate according to the delivery mode
You have to notice that, from the first use of PreparationTime on an offer you cannot update an this offer without preparation time.
Attribute Offer/@BluffDeliveryMax
This attribute describes the maximum number of days to provide products to the warehouse.
this attribute is dedicated to the offers fulfiled on demand by Cdiscount.(fulfillment on demand)
type | xs:int | ||||||||
properties |
| isRef | 0 | use | optional | ||||
isRef | 0 | ||||||||
use | optional | ||||||||
source | <xs:attribute name=” BluffDeliveryMax ” type=”xs:int” use=”optional”/> |
Element ShippingInformationList
This element describes a list of delivery information.
diagram | ![]() | ||||||||||||||||||||||||
namespace | clr-namespace:Cdiscount.Service.OfferIntegration.Pivot;assembly=Cdiscount.Service.OfferIntegration | ||||||||||||||||||||||||
properties |
| content | Complex | ||||||||||||||||||||||
content | Complex | ||||||||||||||||||||||||
children | ShippingInformation | ||||||||||||||||||||||||
used by |
| element | OfferPackage.Offers.Offer | ||||||||||||||||||||||
element | OfferPackage.Offers.Offer | ||||||||||||||||||||||||
attributes |
| Name | Type | Use | Default | Fixed | annotation | Capacity | xs:int | ||||||||||||||||
Name | Type | Use | Default | Fixed | annotation | ||||||||||||||||||||
Capacity | xs:int | ||||||||||||||||||||||||
source | <xs:element name=”ShippingInformationList”> <xs:complexType> <xs:sequence> <xs:element name=”ShippingInformation” maxOccurs=”unbounded” minOccurs=”0″/> </xs:sequence> <xs:attribute type=”xs:byte” name=”Capacity” use=”optional”/> </xs:complexType><xs:element> |
Attribute ShippingInformationList/@Capacity
This attribute describers the number of delivery information.
type | xs:int | ||||||||
properties |
| isRef | 0 | use | |||||
isRef | 0 | ||||||||
use | |||||||||
source | <xs:attribute name=”Capacity” type=”xs:int” use=”required”/> |
Element ShippingInformation
This element describes the information for one activated delivery mode.
Diagram | ![]() | ||||||||||||||||||||||||||||||||||||||||||||||||
Namespace | clr-namespace:Cdiscount.Service.OfferIntegration.Pivot;assembly=Cdiscount.Service.OfferIntegration | ||||||||||||||||||||||||||||||||||||||||||||||||
Properties |
| content | Complex | ||||||||||||||||||||||||||||||||||||||||||||||
content | Complex | ||||||||||||||||||||||||||||||||||||||||||||||||
used by |
| element | ShippingInformation | ||||||||||||||||||||||||||||||||||||||||||||||
element | ShippingInformation | ||||||||||||||||||||||||||||||||||||||||||||||||
Attributes |
| Name | Type | Use | Default | Fixed | annotation | DeliveryMode | xs:string | required | enumeration | ShippingCharges | xs:decimal | required | AdditionalShippingCharges | xs:decimal | |||||||||||||||||||||||||||||||||
Name | Type | Use | Default | Fixed | annotation | ||||||||||||||||||||||||||||||||||||||||||||
DeliveryMode | xs:string | required | enumeration | ||||||||||||||||||||||||||||||||||||||||||||||
ShippingCharges | xs:decimal | required | |||||||||||||||||||||||||||||||||||||||||||||||
AdditionalShippingCharges | xs:decimal | ||||||||||||||||||||||||||||||||||||||||||||||||
Source | <xs:element name=”ShippingInformation” maxOccurs=”unbounded” minOccurs=”0″> <xs:complexType> <xs:attribute type=”xs:decimal” name=”AdditionalShippingCharges” use=”optional”/> <xs:attribute type=”xs:string” name=”DeliveryMode” use=”required”> <xs:simpleType> <xs:restriction base=”xs:string”> <xs:enumeration value=”Standard”/> <xs:enumeration value=”Tracked”/> <xs:enumeration value=”Registered”/> <xs:enumeration value=”Relay”/> <xs:enumeration value=”MondialRelay”/> <xs:enumeration value=”RelaisColis”/> <xs:enumeration value=”SoColissimo”/> <xs:enumeration value=”BigParcelEco”/> <xs:enumeration value=”BigParcelStandard”/> <xs:enumeration value=”BigParcelComfort”/> <xs:enumeration value=”Express”/> <xs:enumeration value=”Fast”/> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute type=”xs:decimal” name=”ShippingCharges” use=”required”/> </xs:complexType></xs:element> |
Attribute ShippingInformation/@DeliveryMode
this attributes contains the delivery mode corresponding to the information.
this attributes must only contains delivery mode activated in the sellershop.
type | xs:string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties |
| isRef | 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isRef | 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
facets |
| Kind | Value | Order ShippingCode | Enumeration | Standard | Normal home delivery | STD | Enumeration | Tracked | Tracked home delivery | TRK | Enumeration | Registered | Registered home delivery | REG | Enumeration | Relay | Delivery in shop | MAG | Enumeration | RelaisColis | RelaisColis delivery | RCO | Enumeration | SoColissimo | So Colissimo delivery | SO1 | Enumeration | MondialRelay | Livraison Mondial Relais | REL | Enumeration | BigParcelEco | Livraison Gros colis Eco (> 30kg) | LV1 | Enumeration | BigParcelStandard | Livraison Gros colis Standard (> 30kg) | LV2 | Enumeration | BigParcelComfort | Livraison Gros colis Confort (> 30kg) | LV3 | Enumeration | Express | Livraison Express | EXP | Enumeration | Fast | Livraison Rapide | FST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Kind | Value | Order ShippingCode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | Standard | Normal home delivery | STD | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | Tracked | Tracked home delivery | TRK | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | Registered | Registered home delivery | REG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | Relay | Delivery in shop | MAG | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | RelaisColis | RelaisColis delivery | RCO | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | SoColissimo | So Colissimo delivery | SO1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | MondialRelay | Livraison Mondial Relais | REL | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | BigParcelEco | Livraison Gros colis Eco (> 30kg) | LV1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | BigParcelStandard | Livraison Gros colis Standard (> 30kg) | LV2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | BigParcelComfort | Livraison Gros colis Confort (> 30kg) | LV3 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | Express | Livraison Express | EXP | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration | Fast | Livraison Rapide | FST | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source | <xs:attribute name=”DeliveryMode” type=”xs:string”/> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
format | Enumeration : Standard, Tracked, Registered, Relay, MondialRelay, RelaisColis, SoColissimo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Attribute ShippingInformation /@ShippingCharges
This attributes contains the shipping unit price according to the shipping mode selected.
type | xs:decimal | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
source | <xs:attribute name=”ShippingCharges” type=”xs:decimal”/> | ||||
format |
| 10 digits, 2 digits for the fractional part | |||
10 digits, 2 digits for the fractional part |
Attribute ShippingInformation /@AdditionalShippingCharges
This attributes contains the shipping unit additional price according to the shipping mode selected
(Price applied from the second ordered article).
If you do not wish to make the shipping price for additional product free, you have to mention it explicitly. As a matter of fact, if you do not mention a value for this attribute, it means additional shipping price is 0 for this mode.
type | xs:decimal | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
source | <xs:attribute name=”AdditionalShippingCharges” type=”xs:decimal”/> | ||||
format |
| 10 digits, 2 digits for the fractional part | |||
10 digits, 2 digits for the fractional part |
Element DiscountComponentList
This element describes a list of flash sales on offer
diagram | ![]() | ||||||||||||||||||||||||
namespace | clr-namespace:Cdiscount.Service.OfferIntegration.Pivot;assembly=Cdiscount.Service.OfferIntegration | ||||||||||||||||||||||||
properties |
| content | complex | ||||||||||||||||||||||
content | complex | ||||||||||||||||||||||||
children | DiscountComponent | ||||||||||||||||||||||||
used by |
| element | OfferPackage.Offers.Offer | ||||||||||||||||||||||
element | OfferPackage.Offers.Offer | ||||||||||||||||||||||||
attributes |
| Name | Type | Use | Default | Fixed | annotation | Capacity | xs:int | ||||||||||||||||
Name | Type | Use | Default | Fixed | annotation | ||||||||||||||||||||
Capacity | xs:int | ||||||||||||||||||||||||
source | <xs:element name=”DiscountComponentList” minOccurs=”1″ maxOccurs=”1″> <xs:complexType> <xs:sequence> <xs:element name=”DiscountComponent” maxOccurs=”unbounded” /> </xs:sequence> <xs:attribute name=”Capacity” type=”xs:int” /> </xs:complexType> </xs:element> |
Attribute DiscountComponentList/@Capacity
This attribute specifies how many there are discount offers for this
type | xs:int | ||||||||
properties |
| isRef | 0 | use | |||||
isRef | 0 | ||||||||
use | |||||||||
source | <xs:attribute name=”Capacity” type=”xs:int” use=”required”/> |
ElementDiscountComponent
This element describes a special offer
Diagram | ![]() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Namespace | clr-namespace:Cdiscount.Service.OfferIntegration.Pivot;assembly=Cdiscount.Service.OfferIntegration | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties |
| content | Complex | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
content | Complex | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used by |
| element | DiscountComponent | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
element | DiscountComponent | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Attributes |
| Name | Type | Use | Default | Fixed | annotation | Type
StartDate | xs :int
xs :dateTime | required
required | SalesReferencePrice | xs:decimal | EndDate | xs:dateTime | required | DiscountValue | xs :decimal | required | DiscountUnit | xs:int | required | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Use | Default | Fixed | annotation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type
StartDate | xs :int
xs :dateTime | required
required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SalesReferencePrice | xs:decimal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndDate | xs:dateTime | required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DiscountValue | xs :decimal | required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DiscountUnit | xs:int | required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Source | <xs:element name=”DiscountComponent” maxOccurs=”unbounded”> <xs:complexType> <xs:attribute name=”Type” use=”required”> <xs:simpleType> <xs:restriction base=”xs:int”> <xs:enumeration value=”1″/> <xs:enumeration value=”2″/> <xs:enumeration value=”3″/> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name=”StartDate” type=”xs:dateTime” use=”required”/> <xs:attribute name=”SalesReferencePrice” type=”xs:decimal”/> <xs:attribute name=”EndDate” type=”xs:dateTime” use=”required”/> |
Attribute DiscountComponent /@Type
This attribute must be equal to 1 or 3 according of the discount type wanted.
type | xs:int | ||||||||||||||||||||||||
properties |
| isRef | 0 | ||||||||||||||||||||||
isRef | 0 | ||||||||||||||||||||||||
facets |
| Kind | Value | annotation | enumeration | 1 | Sales Flash | enumeration | 3 | Sales | |||||||||||||||
Kind | Value | annotation | |||||||||||||||||||||||
enumeration | 1 | Sales Flash | |||||||||||||||||||||||
enumeration | 3 | Sales | |||||||||||||||||||||||
source | <xs:attribute name=”Type” use=”required”> <xs:simpleType> <xs:restriction base=”xs:int”> <xs:enumeration value=”1″/> <xs:enumeration value=”3″/> </xs:restriction> </xs:simpleType> </xs:attribute> | ||||||||||||||||||||||||
format | 1 digit, 1 => Sales Flash; 3 => Sales |
Attribute DiscountComponent /@StartDate
This attribute contains the start date of the promotion.
This attributes is required for the Sales flash, it is not used for the Sales.
type | xs:dateTime | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
source | <xs:attribute name=”StartDate” type=”xs:dateTime” use=”optional”/> | ||||
format | YYYY-MM-DDThh:mm:ss (example : 2002-05-30T09:30:10) |
Attribute DiscountComponent /@EndDate
This attribute contains the start date of the promotion.
This attributes is required for the Sales flash, it is not used for the Sales.
type | xs:dateTime | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
source | <xs:attribute name=”EndDate” type=”xs:dateTime” use=”optional”/> | ||||
format | YYYY-MM-DDThh:mm:ss (example : 2002-05-30T09:30:10) |
Attribute DiscountComponent /@SalesReferencePrice
This attributes contains the reference price used for sales. It is required only if the Type value is Sales .
Type | xs:decimal | ||||
Properties |
| isRef | 0 | ||
isRef | 0 | ||||
Source | <xs:attribute name=”SalesReferencePrice” type=”xs:decimal”/> | ||||
Format |
| 10 digits, 2 digits for the fractional part | |||
10 digits, 2 digits for the fractional part |
Attribute DiscountComponent /@DiscountValue
This attribute contains the percentage amount of the promotion.
type | xs:int | ||||
properties |
| isRef | 0 | ||
isRef | 0 | ||||
Source | <xs:attribute name=”DiscountValue” use=”required”/> | ||||
format |
the value must be greater than or equal to 5 and strictly less than 100 | 10 digits, 2 digits for the fractional part | |||
10 digits, 2 digits for the fractional part |
Attribute DiscountComponent /@DiscountUnit
This attribute contains the type of promotion
type | xs:int | ||||||||||||||||||
properties |
| isRef | 0 | ||||||||||||||||
isRef | 0 | ||||||||||||||||||
facets |
| Kind | Value | annotation | enumeration | 1 | Pourcentage | ||||||||||||
Kind | Value | annotation | |||||||||||||||||
enumeration | 1 | Pourcentage | |||||||||||||||||
source | <xs:attribute name=”DiscountUnit” use=”required”> <xs:simpleType> <xs:restriction base=”xs:int”> <xs:enumeration value=”1″/> </xs:restriction> </xs:simpleType> </xs:attribute> | ||||||||||||||||||
format | 1 digit, 0 |