ValidateOrderListMessage
| Name | Type | Required | Description |
|---|---|---|---|
| OrderList | List<ValidateOrder> | Order List to update. |
ValidateOrder
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNumber | string | Order Number. | |
| OrderState | OrderStateEnum? | Order validation State, can take the following values :
|
|
| OrderLineList | List<ValidateOrderLine> | List of order lines to update. | |
| TrackingNumber | string | Tracking Number. | |
| CarrierName | string | Carrier Name. | |
| TrackingUrl | string | TrackingUrl. |
ValidateOrderLine
| Name | Type | Required | Description |
|---|---|---|---|
| SellerProductId | string | The seller email. | |
| AcceptationState | AcceptationStateEnum | Product acceptation State, can take the following values :
|
|
| ProductCondition | ProductConditionEnum | Product State, can take the following values :
|
|
| Sku | string | The phone number. | |
| TypeOfReturn | AskingForReturnType? | The return actions that the seller can do on external order line(s).Possible Values are the following:
|
Order
| Name | Type | Required | Obsolete | Description |
|---|---|---|---|---|
| ArchiveParcelList | bool | Informs if parcels are filed | ||
| CreationDate | string | Order Creation Date | ||
| Customer | Customer | Customer information. | ||
| ModifiedDate | DateTime? | X | This data is obsolete and was replaced by LastUpdatedDate. | |
| Offer | OfferOrder | An offer order | ||
| OrderNumber | string | Order Number | ||
| ShippingAddress | Address | Customer Shipping Address.This information is only available for the orders in the following states :
|
||
| InitialTotalShippingChargesAmount | decimal | Initial Total Shipping Charges Amount | ||
| InitialTotalAmount | decimal | Total amount of the order. | ||
| ValidationStatus | ValidationStatusType | State of validation of the order:
|
||
| ShippingCode | string | Code du mode de livraison. | ||
| ValidatedTotalAmount | Decimal | The seller email. | ||
| ShippedTotalAmount | Decimal | Order Amount validated by the seller . | ||
| ValidatedTotalShippingCharges | Decimal | Validated Total Shipping Charges (amount validated by the seller). | ||
| ShippedTotalShippingCharges | Decimal | Shipped Total Shipping Charges (amount shipped by the seller). | ||
| OrderLineList | List<OrderLine> | List of OrderLine. | ||
| BillingAddress | Address | Customer Billing Address.This information is only available for the orders in the following states :
|
||
| Status | OrderStatusType | Order initial total amount (when the customer order on the website):
|
||
| ValidationStateType | ValidationStateType | Order validation state, can take the following values :
|
||
| ShippingCode | string | Delivery mode, can take the following values :
|
||
| OrderState | OrderStateEnum? | Order validation State, can take the following values :
|
||
| SiteCommissionPromisedAmount | decimal | Site Commission Promised Amount | ||
| SiteCommissionValidatedAmount | decimal | Site Commission Validated Amount | ||
| SiteCommissionShippedAmount | decimal | Site Commission Shipped Amount | ||
| LastUpdatedDate | DateTime? | Oder’s last update date | ||
| ShippingDateMax | DateTime? | The maximum delivery date | ||
| ShippingDateMin | DateTime? | The minimum delivery date | ||
| HasClaims | bool | True if There are one or more claims on the order | ||
| IsCLogistiqueOrder | bool | X | True if the order is sent by Cdiscount | |
| Corporation | Corporation | This object indicates the website from which the order comes. | ||
| VisaCegid | int? | VisaCegid | ||
| PartnerOrderRef | string | Seller Reference | ||
| ModGesLog | string | Order management mode, can make difference between Seller managed shipments (MKPCDS) and Fulfillment managed shipments (EXTFBC and MKPFBC) | ||
| ParcelList | List<Parcel> | List of parcel’s information | ||
| VoucherList | List<Voucher> | Voucher list | ||
| IsEligibileSubstitution | bool | X | True If the order is eligible to substitution [Coming soon DSI_4714 – (Franprix / Darkstore) : Livraison Express Paris] |
OrderLine
| Name | Type | Required | Description |
|---|---|---|---|
| CategoryCode | string | Category Code referring to the product. | |
| RowId | int | Order line row number | |
| DeliveryDateMax | DateTime | Maximum delivery date. | |
| DeliveryDateMin | DateTime | Minimum delivery date. | |
| Name | string | Product Name | |
| OrderLineChildList | List<OrderLine> | Products of the Nomenclature is the product is a Nomenclature (prodict with sizes / color. | |
| ProductId | string | Product sku . | |
| ProductEan | string | Product EAN 13. | |
| IsProductEanGenerated | bool | True if the product has been created without Ean. | |
| SellerProductId | string | Seller Product Id. | |
| PurchasePrice | decimal | All taxes included unit price of the product* Quantity | |
| Quantity | int | Quantity of the orderline. | |
| ShippingDateMax | DateTime | Minimum Shipping Date. | |
| ShippingDateMin | DateTime | Maximum Shipping Date. | |
| Sku | string | Product SKU. | |
| SkuParent | string | Parent Product SKU. | |
| ProductCondition | ProductConditionEnum? | Product State, can take the following values :
|
|
| UnitShippingCharges | decimal | Unit shipping Charges amount. | |
| UnitAdditionalShippingCharges | decimal | Unit Additional Shipping Charges amount. | |
| AcceptationState | AcceptationStateEnum? | Product acceptation State, can take the following values :
|
|
| HasClaim | bool | True if There are one or more claims on the order line . | |
| IsNegotiated | bool? | The value indicating whether the negotiation is enabled | |
| InitialPrice | decimal | The initial price. | |
| IsCDAV | bool | Indicating whether the line has benifited of CDAV Program | |
| RefundShippingCharges | bool? | indicate if the order line is refunded with shipping charge or not |
OrderFilter
| Name | Type | Required | Description |
|---|---|---|---|
| FetchOrderLines | bool | Indicates if the lines have to be fetched. | |
| States | List<OrderStateEnum> | Order validation State, can take the following values :
|
|
| BeginCreationDate | DateTime? | This date represents the beginning of the period of taking into account, based on the orders creation. | |
| EndCreationDate | DateTime? | This date represents the end of the period of taking into account, based on the orders creation. | |
| BeginModificationDate | DateTime? | This date represents the beginning of the period of taking into account, based on the orders modification. | |
| EndModificationDate | DateTime? | This date represents the end of the period of taking into account, based on the orders modification. | |
| IncludeExternalFbcSiteId | bool | Flag to include/exclude external fbc order. | |
| OrderReferenceList | List |
An order id list. | |
| PartnerOrderRef | string | The PartnerOrderRef. | |
| CorporationCode | string | Identifier of the site. | |
| OrderType | OrderTypeEnum? | OrderTypeEnum:
|
|
| FetchParcels | bool | Indicates if the parcels have to be fetched. | |
| Country | CountryEnum | Indicates the international delivery country, can take the following values :
|
If you cumulate in the filter BeginCreationDate, EndCreationDate, BeginModificationDate, EndModificationDate: the orders which will be fetched will have dates ranging between (BeginCreationDate and EndCreationDate) AND (BeginModificationDate and EndModificationDate).
OfferOrder
| Name | Type | Required | Description |
|---|---|---|---|
| Code | string | Offer code. | |
| CreationDate | string | Offer creation date. | |
| ExpirationDate | string | Offer expiration date. |
CancelOrder
| Name | Type | Required | Description |
|---|---|---|---|
| CarrierName | string | Carrier Name. | |
| OrderNumber | string | Order Number. | |
| TrackingNumber | string | Tracking Number. | |
| TrackingURL | string | Tracking URL. | |
| OrderState | OrderStateEnum | Status of the command to be canceled. | |
| OrderLineList | CancelOrderLine | List of rows of the command to be canceled. |
CancelOrderLine
| Name | Type | Required | Description |
|---|---|---|---|
| AcceptationState | AcceptationStateEnum | The status of the command line to be updated. The allowed values ​​on the API are :
. |
|
| ProductCondition | ProductConditionEnum | State of the product, can take the following values :
. |
|
| SellerProductId | string | Seller Product Id. | |
| Sku | string | Product SKU. |
CancelOrderResult
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNumber | string | Order Number. | |
| Canceled | bool | Takes “true” if the command is canceled “false” otherwise. | |
| Warnings | Error | List of warnings generated by validation. | |
| Errors | Error | List of errors generated by validation. | |
| CancelOrderLineResults | CancelOrderLineResult | List of rows of the command to be canceled. |
CancelOrderLineResult
| Name | Type | Required | Description |
|---|---|---|---|
| SellerProductId | string | Seller Product Id. | |
| Updated | bool | Takes “true” if the command is canceled “false” otherwise . | |
| Errors | Error | List of errors generated by validation. |
CancelOrderResultMessage
| Name | Type | Required | Description |
|---|---|---|---|
| CancelOrderResults | CancelOrderResults | List of canceled orders. |
CancelRequest
| Name | Type | Required | Description |
|---|---|---|---|
| CancelOrder | CancelOrder | The command to cancel. |
ValidationResultMessage
| Name | Type | Required | Description |
|---|---|---|---|
| ValidateOrderResults | List<ValidateOrderResult> | List of order validation reports. |
ValidateOrderResult
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNumber | string | X | Order Number. |
| Validated | bool | Takes the « true » value when order validation correctly processed, « false » in the other case. | |
| Errors | List<Error> | List of errors generated by the validation. | |
| Warnings | List<Error> | List of warnings generated by the validation. | |
| ValidateOrderLineResults | List<ValidateOrderLineResult> | X | List of orderline validation report . |
ValidateOrderLineResult
| Name | Type | Required | Description |
|---|---|---|---|
| SellerProductId | string | Seller Product Id. | |
| Updated | bool | Takes the « true » value if the line state de ligne was modified, « false » otherwise. | |
| Errors | List<Error> | Errors List generated by the validation of an orderline. |
ValidationReturnMessage
| Name | Type | Required | Description |
|---|---|---|---|
| WarnList | List<Error> | Order List to update. |
Corporation
| Name | Type | Required | Description |
|---|---|---|---|
| CorporationId | string | X | Website ID. |
| CorporationName | string | Website name. | |
| BusinessUnitId | string | ID of stock owner. | |
| IsMarketPlaceActive | string | True if this Marketplace is active. | |
| CorporationCode | string | X | Website code. |
Customer
| Name | Type | Required | Description |
|---|---|---|---|
| Civility | Civility? | Customer civility:
|
|
| FirstName | string | Customer First Name. | |
| LastName | string | Customer Last Name. | |
| Phone | string | Customer home phone number. | |
| MobilePhone | string | Customer mobile phone number. | |
| CustomerId | string | Unique customer id. | |
| string | Customer email address. | ||
| EncryptedEmail | string | Crypted e-mail address of the customer. | |
| ShippingFirstName | string | First name of the person informed in the delivery address. | |
| ShippingLastName | string | Name of the person informed in the delivery address. |
OrderListMessage
| Name | Type | Required | Description |
|---|---|---|---|
| OrderList | List<Order> | Seller informationOrder List . |
OrderLineValidationRequest
| Name | Type | Required | Description |
|---|---|---|---|
| AcceptationState | AcceptationStateEnum | State of acceptance of the line:
|
|
| OrderId | string | Identifier of the command. | |
| RowIdList | List |
Order line row identifiers . | |
| SellerCountryCode | string | Code country of the seller. |
SellerRefundRequestMessage
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNumber | string | X | Order number. |
| SellerRefundRequestList | List<SellerRefundRequest> | X | Order lines to refund. |
SellerRefundRequest
| Name | Type | Required | Description |
|---|---|---|---|
| Mode | SellerRefundRequestMode | Refund type :
|
|
| RefundOrderLine | **List<SellerRefundOrderLine>** | X | |
| Motive | RefundMotive | Motive :
|
SellerRefundOrderLine
| Name | Type | Required | Description |
|---|---|---|---|
| SellerProductId | string | X | Seller Product Id. |
| Ean | string | Ean. | |
| RefundShippingCharges | bool? | True : the shipping are refunded.False : the shipping are not refunded.Not specified : the shipping are refunded |
SellerRefundResult
| Name | Type | Required | Description |
|---|---|---|---|
| SellerProductId | string | X | Seller product id . |
| Ean | string | X | Ean. |
| Motive | RefundMotive | X | Motive :
|
| Value | decimal | X | Refund. |
SellerRefundRequestMode
| Name | Type | Required | Description |
|---|---|---|---|
| SellerRefundRequestMode | SellerRefundRequestMode | List of SellerRefundRequestMode that can take the following values :
|
SellerRefundResult
| Name | Type | Required | Description |
|---|---|---|---|
| SellerProductId | string | Product reference | |
| Ean | string | Ean Product | |
| Value | Decimal | Amount reimbursed |
SellerRefundResultMessage
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNumber | string | X | Order number. |
| SellerRefundResultList | List<SellerRefundResult> | X | Order lines refunded. |
GlobalConfigurationMessage
| Name | Type | Required | Description |
|---|---|---|---|
| CarrierList | List<Carrier> | The carrier list.. |
Carrier
| Name | Type | Required | Description |
|---|---|---|---|
| CarrierId | int | The carrier identifier. | |
| Name | string | The name. | |
| DefaultURL | string | The default URL. |
OrderValidationRequest
| Name | Type | Required | Description |
|---|---|---|---|
| OrderId | string | Identifier of the order. | |
| ScopusId | string | ScopusId of the order. | |
| TrackingNumber | string | Tracking number. | |
| CarrierName | string | Name of the carrier. | |
| TrackingUrl | string | Url for the tracking. | |
| SellerCountryCode | string | Country code of the seller. |
OrderResultMessage
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNumber | string | The number of the command created. |
Address
| Name | Type | Required | Description |
|---|---|---|---|
| FirstName | string | First name associated with address | |
| LastName | String | Last name associated with address | |
| Civility | Civility | Civility of the client, can take the following values :
|
|
| Address1 | string | Adress | |
| Address2 | string | Additional address | |
| ZipCode | string | Postal Code | |
| City | bool | City | |
| Country | string | Country | |
| ApartmentNumber | string | Apartment number | |
| Building | string | Building address | |
| CompanyName | string | Company Name | |
| Instructions | string | Special instructions, ie. “Right door after the assistant” | |
| PlaceName | string | Places said / mailbox | |
| RelayId | int | Relay ID | |
| Street | string | Track number and name |
Parcel
| Name | Type | Required | Description |
|---|---|---|---|
| CustomerNum | string | Customer Number | |
| ParcelStatus | ParcelStatus? | Parcel State :
|
|
| ParcelItemList | List<ParcelItem> | Parcel items(items = products) | |
| TrackingList | List<Tracking> | Parcel Tracking list. | |
| ExternalCarrierName | string | Carrier name | |
| ExternalCarrierTrackingUrl | string | Parcel tracking URL. | |
| RealCarrierCode | string | . | |
| IsCustomerReturn | bool | Specify if the parcel has been returned by Customer. |
PayOrder
| Name | Type | Required | Description |
|---|---|---|---|
| CarrierName | string | Carrier Name. | |
| OrderNumber | string | Order Number. | |
| TrackingNumber | string | Tracking Number. | |
| TrackingURL | string | Tracking URL. | |
| OrderState | OrderStateEnum | Status of the command to be canceled. | |
| OrderLineList | PayOrderLine | List of order lines to be paid. |
PayOrderLine
| Name | Type | Required | Description |
|---|---|---|---|
| AcceptationState | AcceptationStateEnum | The status of the command line to be updated.The allowed values ​​on the API are:
|
ParcelItem
| Name | Type | Required | Description |
|---|---|---|---|
| Sku | string | Product code. | |
| Quantity | int | Product quantity. | |
| ProductName | string | Product name. |
Tracking
| Name | Type | Required | Description |
|---|---|---|---|
| TrackingId | int | The tracking id. | |
| ParcelNum | string | The Parcel Number. | |
| Justification | string | The tracking justification. | |
| InsertDate | DateTime? | The insert date. |
ManageParcelRequest
| Name | Type | Required | Description |
|---|---|---|---|
| ScopusId | string | The scopus id. | |
| ParcelActionsList | List<ParcelInfos> | The Parcel action list. |
ParcelInfos
| Name | Type | Required | Description |
|---|---|---|---|
| ManageParcel | ParcelActionTypes | parcelActionTypes can takes values bellow :
|
|
| ParcelNumber | string | The parcel customer number. | |
| Sku | string | The product number. |
PaymentOrderResult
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNumber | string | Order Number. | |
| Paid | bool | Set to true if the command is paid “false” otherwise. | |
| Warnings | Error | List of warnings generated by validation. | |
| Errors | Error | List of errors generated by validation. | |
| PaymentOrderLineResults | PaymentOrderLineResult | List of paid lines. |
PaymentOrderLineResult
| Name | Type | Required | Description |
|---|---|---|---|
| SellerProductId | string | Seller Product Id. | |
| Updated | bool | Set to true if the command is paid “false” otherwise. | |
| Errors | Error | List of errors generated by validation. |
PaymentOrderResultMessage
| Name | Type | Required | Description |
|---|---|---|---|
| PaymentOrderResults | PaymentOrderResult | List of paid orders. |
PaymentRequest
| Name | Type | Required | Description |
|---|---|---|---|
| PayOrder | PayOrder | The order to pay. |
CreateRefundVoucherRequest
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNumber | string | The order number. | |
| SellerRefundList | List<SellerRefundRequest> | The order line list to refund. | |
| CommercialGestureList | List<RefundInformation> | The commercial gesture list request. |
CreateRefundVoucherMessage
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNumber | string | The order number. | |
| SellerRefundList | List<SellerRefundResult> | The refunded order line list. | |
| CommercialGestureList | List<RefundInformationMessage> | The commercial gesture list result. |
RefundInformation
| Name | Type | Required | Description |
|---|---|---|---|
| Amount | decimal | The Commercial gesture Amount. | |
| Motive | int | The commercial gesture motive id, can takes values bellow :
|
RefundMotive
| Name | Type | Required | Description |
|---|---|---|---|
| Motive | RefundMotive | List of RefundMotive that can take the following values:
|
Voucher
| Name | Type | Required | Description |
|---|---|---|---|
| CreateDate | DateTime? | The creation date. | |
| RefundInformation | RefundInformation | The commercial gesture informations |
RefundInformationMessage
| Name | Type | Required | Description |
|---|---|---|---|
| Amount | decimal | The Commercial gesture Amount. | |
| Motive | int | The commercial gesture motive id, can takes values bellow :
|
FakeOrderRequest
| Name | Type | Required | Description |
|---|---|---|---|
| NumberOfProducts | int | The number of products of the order. | |
| Quantity | int | Quantity of products ordered. | |
| ShippingCode | ShippingCodeEnum | Mode of delivery, can take the following values:
. |
|
| ProductType | ProductTypeEnum | Type of product ordered, can take the following values :
. |
|
| PaymentMode | PaymentModeEnum | Payment method, can take the following values :
. |
|
| Tenant | TenantEnum | Tenant, can take the following values :
. |
ServiceOrder
| Name | Type | Required | Obsolete | Description |
|---|---|---|---|---|
| ArchiveParcelList | bool | Informs if parcels are filed | ||
| CreationDate | string | Order Creation Date | ||
| Customer | Customer | Customer information. | ||
| ModifiedDate | DateTime? | X | This data is obsolete and was replaced by LastUpdatedDate. | |
| Offer | OfferOrder | An offer order | ||
| OrderNumber | string | Order Number | ||
| ShippingAddress | Address | Customer Shipping Address.This information is only available for the orders in the following states :
|
||
| InitialTotalShippingChargesAmount | decimal | Initial Total Shipping Charges Amount | ||
| InitialTotalAmount | decimal | Total amount of the order. | ||
| ValidationStatus | ValidationStatusType | State of validation of the order:
|
||
| ShippingCode | string | Code du mode de livraison. | ||
| ValidatedTotalAmount | Decimal | The seller email. | ||
| ShippedTotalAmount | Decimal | Order Amount validated by the seller . | ||
| ValidatedTotalShippingCharges | Decimal | Validated Total Shipping Charges (amount validated by the seller). | ||
| ShippedTotalShippingCharges | Decimal | Shipped Total Shipping Charges (amount shipped by the seller). | ||
| OrderLineList | List<OrderLine> | List of OrderLine. | ||
| BillingAddress | Address | Customer Billing Address.This information is only available for the orders in the following states :
|
||
| Status | OrderStatusType | Order initial total amount (when the customer order on the website):
|
||
| ValidationStateType | ValidationStateType | Order validation state, can take the following values :
|
||
| ShippingCode | string | Delivery mode, can take the following values :
|
||
| OrderState | OrderStateEnum? | Order validation State, can take the following values :
|
||
| SiteCommissionPromisedAmount | decimal | Site Commission Promised Amount | ||
| SiteCommissionValidatedAmount | decimal | Site Commission Validated Amount | ||
| SiteCommissionShippedAmount | decimal | Site Commission Shipped Amount | ||
| LastUpdatedDate | DateTime? | Oder’s last update date | ||
| ShippingDateMax | DateTime? | The maximum delivery date | ||
| ShippingDateMin | DateTime? | The minimum delivery date | ||
| HasClaims | bool | True if There are one or more claims on the order | ||
| IsCLogistiqueOrder | bool | X | True if the order is sent by Cdiscount | |
| Corporation | Corporation | This object indicates the website from which the order comes. | ||
| VisaCegid | int? | VisaCegid | ||
| PartnerOrderRef | string | Seller Reference | ||
| ModGesLog | string | Order management mode, can make difference between EXTFBC and MKPFBC orders | ||
| ParcelList | List<Parcel> | List of parcel’s information | ||
| VoucherList | List<Voucher> | |||
| AssociatedOrderInfoList | List<AssociatedOrderInfo> | List of information for associated order |
AssociatedOrderInfo
| Name | Type | Required | Obsolete | Description | |
|---|---|---|---|---|---|
| OrderNumber | string | Order identifiant | |||
| ServiceOrderNumber | string | Service Order identifian | |||
| Sku | string | Product SKU. | |||
| SkuAssociated | string | Assembly srevice sku | |||
| CreationDate | string | Order Creation Date | |||
| OrderState | OrderStateEnum? | Order validation State, can take the following values :
|
|||
| RealDeliveryDate | DateTime? | the shipping date of the associated order | |||
| CustomerMail | string | ||||
| CustomerPhone | string | Customer information. | |||
| ProductSheetUrl | string | www.cdiscount.com/dp.aspx?sku=[SKU] | |||
| ShippingAddress | Address |
