Event representing an order. The source can be spark or the opco backend.
An order as created by spark
A base order defining properties common to any kind of order
This object is used to describe some technical meta information related to the event
The application source of this event
The version of the json format event
The order id generated by the spark plateform.
"4999569661752721026"
The parent order id generated by the spark plateform, used to group spark orders associated to the same customer order.
"315627244210393088"
Tenant identifier for an Opco in SPARK multitenant platform
"BEL-CEBEO"
The Cart or the open order identifier at opco backend system level
"1234"
The Cart or the open order identifier at spark level. When known it should always be present throughout the order lifecycle. This is mandatory on online orders to activate the AX feature (used to identify abandoned cart).
"1234"
Optional field, needed by OpCo organised with a regional model or commercial organisation. It can be used to filter or route based on the orgId.
"org123"
"SNE"
The sales channel where the order is placed
"ESHOP"
The status of the order. The OpCo can send any status codes that are associated with the order in their systems. The status codes sent will need to be mapped to labels in the CMS.
"OPENED"
"VALIDATED"
"IN_PROGRESS"
"CLOSED"
The date when the order was placed
"2021-10-12T08:30:22.804Z"
The date when the order was last modified. This field will be used to ensure that only the latest update are being integrated to order history.
"2021-10-12T08:30:22.804Z"
The opco account id of the customer.
"12345"
The list of users that contribute on the creation if the cart and the order. The creator of the cart, the validator of the cart ...
No Additional Items[
{
"fullName": "John Smith",
"email": "john.smith@mycompany.com",
"creator": true
},
{
"fullName": "John Validator",
"email": "john.validator@mycompany.com"
}
]
The full name of a contributor.
"John Smith"
The email of a contributor. this is the identifier of the user on spark
"john.smith@mycompany.com"
A boolean that when is true means that the current contributor is the creator of the cart from where this order is created.
"false"
A boolean that when is true means that the current contributor has placed the order (transformed the cart to an order).
"false"
A boolean that when is true means that the current contributor has validated the cart during the approval workflow.
"false"
A boolean that when is true means that the current contributor is an associate doing the action on behalf of the end user.
"false"
The billing address
{
"opCoAddressId": "13543678",
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "1st floor",
"addressLine3": "Apparment 2",
"postalCode": "0287",
"city": "Bruges",
"region": "Frandre",
"department": "N/A",
"country": "BEL"
}
OpCo internal system's unique identifier for the address.
"237564557868778"
Should contains the Given name, Surname, the name of the company
"235 Donaghy Ave"
Should contains the street No, street name, street type
Should contains the Floor
The postal code
"V7P 1E2"
The city in which the street address is, and which is in the adminDevison(region)
"North Vancouver"
The region in which the locality is, and which is in the country.
"BC"
The department in which the locality is, and which is in the country.
"BC"
The ISO 3166-1 alpha-3 of the country
"CAN"
The address identifier from Spark system
"50169486938114"
List of special price agreements activated in this order
No Additional ItemsA special price agreement associated to an order or a price
The special price agreement identifier in the OpCo back-end system
"SPA-984"
The title of the special price agreement
"Special price agreement 984"
[
{
"id": "SPA-876",
"title": "Special price agreement 876"
},
{
"id": "SPA-547",
"title": "Special price agreement 547"
}
]
Line items that are ordered.
Must contain a minimum of 1 items
The order line item
The ID of the line item.
Must match regular expression:^[0-9]+$
"4999569661752721026"
The identifier of the line item into the opco side for the case of a cart created from a quote. It can be an alpha numeric.
"4999569661752721026"
"ITEM1"
The type of the line item, default is PRODUCT.
- PRODUCT when the line item is a product known by spark - OFFLINE_PRODUCT when the line item is a product unknown by spark
- PROMOTION when the line item is a cart promotion
- SERVICE when the line item is an extra cost or an additional service
"PRODUCT"
Number of items ordered.
10
Product data as seen by customer from the time of the order placement.
A unique identifier of the product.
- In case of promotion lineItem this should contain the id of the promotion.
"9554961192345"
global trade identifier number e.g EAN, UPC etc
"4012196097579"
This is the local product id could be specific to opcos, most cases it is same as manufacturer id but could be different as well
"732D16"
"9554961192345"
This is the equivalent of manufacturer PID and used for search and identifying the product
"1360167"
manufacturer type description identifier, represents the references
"2037 12-20 LGR"
the customer ref for the product, Supported by all special chars respecting the pattern
Must match regular expression:[a-zA-Z0-9_.+@() /$"=#,;'£\\:°*&%-]+
Short description of the product.
For PRODUCT lineItems, it is sourced from the product.identifier.productTitle field.
"LIGHT 274498 Metal Halide Lamp"
Brand name.
For PRODUCT lineItems, it is sourced from the product.identifier.brandName field.
"SASS"
Details of the promotion applied to this line item
{
"title": "Achete 3 articles et 2 gartuit",
"alternateProductId": "767867",
"campaignId": "234"
}
A readable description explaining the promotions eligibility received from opco, Send the title according to chosen language
"achetez 3 articles et obtenez 10% de réduction"
Campaign id to which this promotion is associated to relative to the standard product id
"7575785"
The alternate product id (Since promotions in cebeo is handled by maintaining 2 different id for normal and promotional product), might not be required by other opco
"9898989"
Contains the detail of prices related to the current product and line item
This is the product unit price that the customer will pay to the OPCO, without taxes, before applying promotion.
{
"amount": 1000,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Details about the type of this price
{
"type": "SPECIAL_PRICE_AGREEMENT",
"id": "SPA-876",
"title": "Special price agreement 876"
}
An identifier of the contract or project related to this price
"SPA-984"
"PROJECT-7463"
A short title for this price
"Special price agreement 984"
"Contract schneider"
The type of this price
"SPECIAL_PRICE_AGREEMENT"
"MARKETPLACE"
Percentage of discount on net price, If we have this value then promotionalNetPrice is needed also
10.0
Precomputed promotional price on top of netPrice, This is the case when promotional percentage is not present and the promotional price is directly computed and available to show
{
"amount": 200,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Precomputed quote price on top of netPrice. This is the case when the cart is created from a quote and the OPCO give a preferential price for the product.
{
"amount": 900,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
List of taxes to be applied to net price or promotional net price in case of promotion
No Additional ItemsContains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesContains the amount informations based on the type of prices we might have
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
[
{
"type": "VAT",
"isSurcharge": false,
"percentage": 20.0
}
]
The comment is added to line item by the customer during the order placement. It is used by the customer to provide any information to be received by their own team when the order is delivered.
"Please place this item on 3rd floor"
Contains marketplace properties specific to this lineItems, once set these are assumed to be immutable.
The identifier of this lineItem in the opco purchase order
Purchase unit price (computed by the marketplace platform from the commission rate and the provided offer price)
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The id of a cut group, groups several cutting lines
"10"
Cutting line identifier, group of elements with the same cutting length
"1"
[
{
"id": "4999569661752721000",
"orderedQuantity": 10,
"product": {
"productId": "4999569661752721000",
"productTitle": "SIEMENS Circuit Breaker",
"brandName": "Siemens"
},
"prices": {
"netPrice": {
"amount": 1000,
"scale": 2,
"currency": "EUR"
},
"promotionalNetPrice": {
"amount": 900,
"scale": 2,
"currency": "EUR"
},
"taxes": [
{
"type": "VAT",
"isSurcharge": false,
"percentage": 20.0
}
]
}
}
]
List of coupon added to the cart.
Must contain a minimum of 1 items
This object represent a coupon into cart
- when the coupon will be added by the user the request will contains only the code
- if the coupon is not valid, we expect the opco to send a message with severity ERROR to inform the user
- if the coupon is valid but condition are not yet reached (more product should be added), we expect the opco to send a message with severity INFO
- if the coupon is valid and a discount have to be applied, we expect the opco to set the discount amount
- if the coupon have to be applied alone the exclusive should be set to true
A unique identifier of a coupon
A readable description explaining the details of this coupons eligibility received from opco, Send the title according to chosen language
The discount applied by this coupon
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Used in case of coupon.
- When true no coupon can be applied with this one.
- When false other coupon can be applied with this one.
Payment terms associated with the order
No Additional ItemsTerms and conditions by which a payment has been or will be made.
The payment method type
"CREDIT_LINE"
The transaction payment id
"PAY0001"
The amount of the payment
{
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Date on which the payment transaction has been created
"2017-07-21T08:30:22.804Z"
[
{
"paymentMethod": "CREDIT_LINE",
"amount": {
"amount": 10000,
"scale": 2,
"currency": "EUR"
},
"paymentTransactionId": "12345",
"createdAt": "2017-07-21T17:32:28Z"
}
]
The total price of all items of the order applying promotions and coupons, including all taxes.
{
"amount": 17760,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all items of the order including promotions and including surcharges.
{
"amount": 17760,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Additional information for the order.
Order reference for the customer (ex: customer purchase order id).
"XDFG334322"
The cart name.
"Site 1 Cart"
The project associated to the order
The identifier of the project
The name of the project to display to the customer
The quote associated to the order
The identifier of the quote
"4999569661752721026"
"4999569661_ORG1"
The quote code provided by the OpCo for the Customer. If this field is provided, spark will display it to the customer instead of the quoteId
"49995666"
"4999569661"
The name of the Quote.
The version of this quote. Used by some opco system to select the right version of the quote.
"1"
The type of the quote. STANDARD for normal quotes, BLANKET for quote representing blanket orders. Default value if not present is STANDARD.
"STANDARD"
Contact first name for this order. This field is added by the customer to override the same field into delivery address.
"Robert"
Contact last name for this order. This field is added by the customer to override the same field into delivery address.
"Fox"
Contact phone number for this order. This field is added by the customer to override the same field into delivery address.
"+3333333333"
Contact email for this order.
"john.doe@sonepar.com"
Choice of showing or not the price on the logistics note.
false
An optional emails list that will be used as additional recipients to send the confirmation email of the order
No Additional ItemsThe notes related to the order.
No Additional ItemsObject representing a note
Choice of showing or not the note on the invoice.
true
Choice of showing or not the note on the logistics notes.
false
Note added to cart
"Morning delivery preference"
[
{
"noteOnInvoice": true,
"noteOnLogisticsNotes": false,
"noteText": "Morning delivery preference"
}
]
Additional order information filled by the customer when placing the order or added by the OpCo system during the order processing.
No Additional ItemsObject representing an additional reference.
Name of the additional reference
"warehouseName"
Value of the additional reference filled by the customer
"P570629"
[
{
"name": "warehouseName",
"value": "Z.I. Fourviere"
}
]
This property if present acts as a flag to identify an order as a marketplace one. It contains all marketplace specific order properties.
No Additional PropertiesIdentifier of the purchase order to be sent by the OpCo to the Seller.
It is not to be confused with the customer purchaseOrder defined as part of the additional order information, which is an an optional identifier of the order as referenced by the customer.
Contains seller information
OpCo SellerId, as provided operator internal id for this seller.
Seller name
The IETF BCP 47 language tag of the locale (language and country) as used by the customer on spark front-end for this order.
"fr-FR"
Defines additional fields specific to Spark Orders
No Additional PropertiesInformation about the logistic details of the current cart (logistic method, logistic preferences, logistic options, delivery address, facility id)
{
"logisticMethod": "DELIVERY",
"facilityId": 395,
"deliveryAddress": {
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
},
"logisticOption": {
"code": "STANDARD",
"title": "STANDARD delivery",
"description": "Choose this option if you want a fast delivery",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"logisticScenario": {
"code": "1_DELIVERY",
"title": "1 DELIVERY",
"description": "Choose this scenario if you want all your products to be delivered at the same time",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"totalPrice": {
"amount": 2300,
"scale": 2,
"currency": "EUR"
},
"totalPriceIncludingSurchargesAndShipping": {
"amount": 1900,
"scale": 2,
"currency": "EUR"
},
"shippingGroups": [
{
"status": "VALIDATED",
"deliveryDate": "2021-10-12T08:30:22.804Z",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 200,
"weightUnit": "KGM",
"lastMessageUpdate": {
"type": "INFORMATION",
"message": {
"fr-BE": "Votre commande est bien reçue et validée",
"nl-BE": "Uw bestelling is goed ontvangen en gevalideerd"
}
}
},
"lineItems": [
{
"quantity": 1,
"lineItemId": "1",
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
],
"alternativeLogisticDetails": {
"logisticMethod": "DELIVERY",
"facilityId": "11223344"
}
}
]
}
}
}
Logistic method chosen for the cart
"PICK_UP"
Unique identifier of the locker related to the 'facilityId' where the customer want pick up his order. The facilityId still the place where the order will be prepared
"395"
Unique identifier of the facility used when logistic method is 'PICK_UP'.
"395"
The id of the CDC from where this cart should be delivered. Needed to compute the right stock into PLP/PDP ....In case of multi CDC, the OpCo may have dynamic computation of the CDC and not only a static relation between branch and CDC.
"2Z1"
The address used for delivery when logistic method is 'DELIVERY'
An address.
OpCo internal system's unique identifier for the address.
"237564557868778"
Should contains the Given name, Surname, the name of the company
"235 Donaghy Ave"
Should contains the street No, street name, street type
Should contains the Floor
The postal code
"V7P 1E2"
The city in which the street address is, and which is in the adminDevison(region)
"North Vancouver"
The region in which the locality is, and which is in the country.
"BC"
The department in which the locality is, and which is in the country.
"BC"
The ISO 3166-1 alpha-3 of the country
"CAN"
The address identifier from Spark system
"50169486938114"
Represents additional fields of the delivery address
Extra description about the address
"Building site 1"
Company name, it might differ from the account name
"Easy Electric"
Address contact's first name
"John"
Address contact's last name
"Doe"
Address contact's Phone number (The phone number of the person receiving the shipment)
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
{
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
}
The logistic option chosen for the selected logistic method (e.g a standard delivery is a logistic option).
{
"code": "STANDARD",
"title": "STANDARD delivery",
"description": "Choose this option if you want a fast delivery",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"logisticScenario": {
"code": "1_DELIVERY",
"title": "1 DELIVERY",
"description": "Choose this scenario if you want all your products to be delivered at the same time",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"totalPrice": {
"amount": 2300,
"scale": 2,
"currency": "EUR"
},
"totalPriceIncludingSurchargesAndShipping": {
"amount": 1900,
"scale": 2,
"currency": "EUR"
},
"shippingGroups": [
{
"status": "IN_PREPARATION",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 200,
"weightUnit": "GRM",
"estimatedDeliveryDate": "2021-10-12T08:30:22.804Z",
"lastMessageUpdate": {
"type": "WARNING",
"message": {
"fr-BE": "certains produits que vous avez commandés ne sont pas disponibles et seront livrés à la date de livraison estimée, veuillez contacter votre représentant commercial pour plus d'informations",
"nl-BE": "sommige producten die u hebt besteld, zijn niet beschikbaar en worden geleverd op de geschatte leverdatum. Neem contact op met uw verkoper voor meer informatie"
}
}
},
"lineItems": [
{
"quantity": 1,
"lineItemId": "1",
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
],
"alternativeLogisticDetails": {
"logisticMethod": "DELIVERY",
"facilityId": "11223344",
"deliveryAddress": {
"opCoAddressId": "1234567890",
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
}
}
}
]
}
}
The code of the logistic option
"STANDARD"
The title of the logistic option to be displayed to the end user.
"STANDARD delivery"
The description of the logistic option to be displayed to the end user.
"choose this option if you want a fast delivery"
The cost of this logistic option
{
"amount": 0,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
This is the chosen logistic scenarios from the ones available for the current logistic option.(e.g deliver all the products at the same time is a logistic scenario)
{
"selected": true,
"code": "1_DELIVERY",
"title": "1 DELIVERY",
"description": "Choose this scenario if you want all your products to be delivered at the same time",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"totalPrice": {
"amount": 2300,
"scale": 2,
"currency": "EUR"
},
"totalPriceIncludingSurchargesAndShipping": {
"amount": 1900,
"scale": 2,
"currency": "EUR"
},
"shippingGroups": [
{
"status": "SHIPPED",
"deliveryDate": "2021-10-12T08:30:22.804Z",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 200,
"weightUnit": "GRM",
"lastMessageUpdate": {
"type": "INFORMATION",
"message": {
"fr-BE": "Votre commande est en cours de livraison et devrait être livrée d'ici 15h aujourd'hui",
"nl-BE": "Je bestelling is klaar voor bezorging en zou vandaag om 15u bezorgd moeten zijn"
}
},
"additionalInfo": [
{
"name": "receivers ref",
"value": "5236776"
},
{
"name": "Sales Rep Message",
"value": "Your Order is in preparation and we dont see any issues"
},
{
"name": "carrier info",
"value": "APOLLO AS"
}
]
},
"lineItems": [
{
"quantity": 1,
"lineItemId": "1",
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
]
}
]
}
The code of the logistic scenario
"1_DELIVERY"
The title of the logistic scenario to be displayed to the end user.
"1 DELIVERY"
The description of the logistic scenario to display to the end user.
"choose this scenario if you want all your products to be delivered at the same time"
The cost of this logistic scenario
{
"amount": 0,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Total price of the logistic scenario including promotions, surcharges, shipping cost and taxes (vat)
{
"amount": 0,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Total price of the logistic scenario including promotions, surcharges, shipping cost without taxes (vat)
{
"amount": 0,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
A list of groups of line items corresponding to the way the order will be fulfilled
No Additional ItemsOrder shipment
The status of the shipping group.
OpCos can send any status supported by their backend system.
The status codes sent are mapped to labels in the CMS and displayed as how customers want to see these status on CX UI without stepper.
Only exception for that, the following status:
- When CX push the order shipping groups will have the status OPENED
- For cancelled lineItems, a shipping group with a status value CANCELLED is expected.
- For back ordered lineItems, a shipping group with a status value BACK_ORDERED is expected.
To enable the track and trace CX feature, where a stepper is displayed and notifications are sent to the user when status are changing, the OpCos have to send the following normalised status list:
- ACCEPTED for the orders first validation or acceptance by OpCo
- REJECTED status should be used when (part of) the order is refused (not ACCEPTED)
- IN_PREPARATION for the orders in preparation until they are shipped
- SHIPPED for all the orders Shipped and in Transit
- DELIVERED for all the orders delivered at source
- AVAILABLE_FOR_PICKUP status should be used in PICKUP when the order is ready to be picked up in branch
- AVAILABLE_IN_LOCKER status should be used in PICKUP when the order is ready to be picked up in locker
- COLLECTED status should be used in PICKUP when the order has been collected from branch or locker.
NOTE:
Using status codes, which are not part of the list above in track and trace section will be displayed without the stepper and no track and trace notifications will be triggered..
"ACCEPTED"
"IN_PREPARATION"
"SHIPPED"
"DELIVERED"
"CANCELLED"
"BACK_ORDERED"
"OPENED"
"AVAILABLE_FOR_PICKUP"
"AVAILABLE_IN_LOCKER"
"COLLECTED"
"REJECTED"
Will be true if the delivery date is selected by the customer. It will be false is the date is the one computed by the opco backend system.
[Deprecated - Use instead expectedDeliveryDate and expectedDeliveryTime].
Date on which the shipment expected to be delivered.
"2021-10-12T08:30:22.804Z"
Date on which the shipment expected to be delivered.
"2021-10-12"
Time on which the shipment expected to be delivered
"08:30:22.804Z"
Used only on Marketplace context Latest date on which the shipment is expected to be delivered.
"2021-10-12"
Used only on Marketplace context Latest time on which the shipment is expected to be delivered.
"08:30:22.804Z"
This object contains the details of tracking the delivery
The number of packages to be delivered
5
The total weight of all packages to be delivered
200
The units in which the weights are computed and displayed following the GS1 units of measure
"KGM"
A type and message object, where type is Info or Warning and message is the actual update
The type of the message whether its info or warning
"INFORMATION"
The actual message for the last update
{
"fr-BE": "Votre commande est en cours de livraison et devrait être livrée d'ici 15h aujourd'hui",
"nl-BE": "Je bestelling is klaar voor bezorging en zou vandaag om 15u bezorgd moeten zijn"
}
Each additional property must conform to the following schema
Type: stringIf there is an issue or delay then last message update is an apology message with new estimated delivery date
"2021-10-12T08:30:22.804Z"
Any additional info related to this delivery
No Additional ItemsA free key value pair field to add any specific messages or details
The name or identifier for an additional info
"receivers ref"
"senders ref"
"carrier name"
"additional instructions"
The value for the named additional info
"6868686"
"24424"
"APOLLO AS"
This object contains the logistic details associated with the shipping groupin cases where additional logistic details are applicable. e.g Logistic Details / Facility for each shipping intent group to support multi-cdc delivery.
{
"logisticMethod": "DELIVERY",
"facilityId": "11223344",
"deliveryAddress": {
"opCoAddressId": "1234567890",
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
}
}
{
"logisticMethod": "DELIVERY",
"facilityId": "11223344"
}
OpCo internal system's unique identifier for the address.
The id of the facility (branch or CDC) associated with the logistic details
"AB2"
The delivery address associated to the account where the order should be delivered.
An address.
OpCo internal system's unique identifier for the address.
"237564557868778"
Should contains the Given name, Surname, the name of the company
"235 Donaghy Ave"
Should contains the street No, street name, street type
Should contains the Floor
The postal code
"V7P 1E2"
The city in which the street address is, and which is in the adminDevison(region)
"North Vancouver"
The region in which the locality is, and which is in the country.
"BC"
The department in which the locality is, and which is in the country.
"BC"
The ISO 3166-1 alpha-3 of the country
"CAN"
The address identifier from Spark system
"50169486938114"
Represents additional fields of the delivery address
Extra description about the address
"Building site 1"
Company name, it might differ from the account name
"Easy Electric"
Address contact's first name
"John"
Address contact's last name
"Doe"
Address contact's Phone number (The phone number of the person receiving the shipment)
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
{
"opCoAddressId": "1234567890",
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
}
The line items that are shipped.
No Additional ItemsOptional. The line items that are shipped.
No Additional PropertiesA reference to a line item. This field is a 64-bit long number represented as a string to avoid unwanted conversions to scientific notation when dealing with the model inside js code
Must match regular expression:^[0-9]+$
"2196602318024039368"
The quantity that is shipped.
1
This is the line item price that the customer will pay to the OPCO, without taxes, after applying promotion. Equals (unitPrice * quantity) for items without promotion or (discountedUnitPrice * quantity) for items with promotion
{
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
This is the shipping cost for this line item, provided when known. The logistic scenario cost should be equal to the sum of all lineItems shipping cost from all (non canceled) shipping group.
{
"amount": 200,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
This is the list of taxes applicable to this lineItem, amounts are total taxes amounts for this lineItem. It includes surchages (isSurchage:true), taxes on the (itemPrice + surchages), taxes on shippingCosts (isShipping:true).
Contains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesContains the amount informations based on the type of prices we might have
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
[
{
"type": "VAT",
"code": "tax-fra-55",
"taxAmount": {
"amount": 550,
"scale": 2,
"currency": "EUR"
},
"percentage": 5.5
},
{
"type": "ECOTAXE1",
"isSurcharge": true,
"taxAmount": {
"amount": 1500,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "ECOTAXE2",
"isSurcharge": true,
"taxAmount": {
"amount": 500,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "VAT",
"code": "tax-fra-20",
"isShipping": true,
"taxAmount": {
"amount": 20,
"scale": 2,
"currency": "EUR"
},
"percentage": 20
}
]
Additional information only present in marketplace shippingGroups. These order line attributes can be updated throughout the order lifecycle.
Purchase order line’s commission fee. Equals (itemPrice + surchages) * commission_rate
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Purchase order line’s commission fee on shipping. Equals line item shippingCost * commision_rate_on_shipping
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Purchase order line’s price excluding shipping charges. Equals (itemPrice + surchages) - purchaseCommissionOnPrice
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Purchase order line’s shipping charges. Equals line item shippingCost - purchaseCommissionOnShipping
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Purchase order line's taxes. The list of taxes matches the itemTaxes but for the purchase order
No Additional ItemsContains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesContains the amount informations based on the type of prices we might have
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
[
{
"quantity": 4,
"lineItemId": "1",
"itemPrice": {
"amount": 4000,
"scale": 2,
"currency": "EUR"
},
"shippingCost": {
"amount": 1000,
"scale": 2,
"currency": "EUR"
},
"itemTaxes": [
{
"type": "VAT",
"code": "tax-fra-55",
"taxAmount": {
"amount": 2640,
"scale": 2,
"currency": "EUR"
},
"percentage": 5.5
},
{
"type": "ECOTAXE1",
"isSurcharge": true,
"taxAmount": {
"amount": 150,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "ECOTAXE2",
"isSurcharge": true,
"taxAmount": {
"amount": 50,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "VAT",
"code": "tax-fra-20",
"isShipping": true,
"taxAmount": {
"amount": 200,
"scale": 2,
"currency": "EUR"
},
"percentage": 20
}
],
"marketplace": {
"purchaseCommissionOnPrice": {
"amount": 960,
"scale": 2,
"currency": "EUR"
},
"purchaseCommissionOnShipping": {
"amount": 200,
"scale": 2,
"currency": "EUR"
},
"purchaseNetPrice": {
"amount": 3840,
"scale": 2,
"currency": "EUR"
},
"purchaseShippingPrice": {
"amount": 800,
"scale": 2,
"currency": "EUR"
},
"purchaseItemTaxes": [
{
"type": "VAT",
"code": "tax-fra-55",
"taxAmount": {
"amount": 2112,
"scale": 3,
"currency": "EUR"
},
"percentage": 5.5
},
{
"type": "ECOTAXE1",
"isSurcharge": true,
"taxAmount": {
"amount": 1500,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "ECOTAXE2",
"isSurcharge": true,
"taxAmount": {
"amount": 500,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "VAT",
"code": "tax-fra-20",
"isShipping": true,
"taxAmount": {
"amount": 160,
"scale": 2,
"currency": "EUR"
},
"percentage": 20
}
]
}
}
]
Documents references associated with this shipping group
No Additional ItemsInformation identifying a document and potentially a line within the document for referencing purposes.
The type of the document
"INVOICE"
The id of the document
"4999569661752721026"
Date on which the document has been created, in ISO 8601 format.
"2017-07-21T08:30:22.804Z"
System/component where the document is to be sourced from.
"MARKETPLACE"
"OPCO"
[
{
"type": "DELIVERY_NOTES",
"id": "4999569661752721026",
"createdAt": "2017-07-21T17:32:28Z"
}
]
Identifier that identify the logisticOrder generated and provided by the OpCo
"s01242"
"298"
[
{
"status": "SHIPPED",
"deliveryDate": "2021-10-12T08:30:22.804Z",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 200,
"weightUnit": "KGM",
"lastMessageUpdate": {
"type": "INFORMATION",
"message": {
"fr-BE": "Votre commande est en cours de livraison et devrait être livrée d'ici 15h aujourd'hui",
"nl-BE": "Je bestelling is klaar voor bezorging en zou vandaag om 15u bezorgd moeten zijn"
}
},
"additionalInfo": [
{
"name": "receiver's ref",
"value": "5236776"
},
{
"name": "Sales Rep Message",
"value": "Your Order is in preparation and we dont see any issues"
},
{
"name": "carrier info",
"value": "APOLLO AS"
}
]
},
"lineItems": [
{
"quantity": 1,
"lineItemId": "1",
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
]
}
]
{
"eventHeader": {
"source": "SPARK",
"version": "v1"
},
"sparkOrderId": "96122368729817088",
"opcoId": "BEL-CEBEO",
"salesChannel": "ESHOP",
"status": "OPENED",
"placedDate": "2021-07-08T14:17:46.218772Z",
"accountId": "59852",
"opcoCartId": "24777877",
"billingAddress": {
"opCoAddressId": "59852",
"addressLine1": "Rue Vandercoilden 4A",
"city": "Herseaux",
"region": "Wallonie",
"country": "BEL",
"postalCode": "7712"
},
"logisticDetails": {
"logisticMethod": "PICK_UP",
"facilityId": "114",
"deliveryAddress": {
"opCoAddressId": "59852",
"addressLine1": "Rue Vandercoilden 4A",
"city": "Herseaux",
"region": "Wallonie",
"country": "BEL",
"postalCode": "7712",
"addressName": "Rue Vandercoilden 4A",
"companyName": "SPRL FRED ELECTRIQUE"
},
"logisticOption": {
"code": "EXPRESS",
"title": "Express delivery",
"logisticScenario": {
"code": "2_PICK_UP",
"title": "2 pick-up",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"totalPriceIncludingSurchargesAndShipping": {
"amount": 31600,
"scale": 2,
"currency": "EUR"
},
"totalPrice": {
"amount": 38170,
"scale": 2,
"currency": "EUR"
},
"shippingGroups": [
{
"status": "IN_PREPARATION",
"dateChosenByCustomer": false,
"deliveryDate": "2021-07-12T00:00:00Z",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 20.98,
"weightUnit": "GRM",
"lastMessageUpdate": {
"type": "INFORMATION",
"message": {
"fr-BE": "Votre commande est préparée et prête à être expédiée",
"nl-BE": "Je bestelling is klaargemaakt en klaar om verzonden te worden"
}
}
},
"lineItems": [
{
"lineItemId": "96122268053639168",
"quantity": 3,
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
},
{
"lineItemId": "96121848778428416",
"quantity": 3,
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
],
"alternativeLogisticDetails": {
"logisticMethod": "DELIVERY",
"facilityId": "11223344"
}
},
{
"status": "SHIPPED",
"dateChosenByCustomer": false,
"deliveryDate": "2021-07-19T00:00:00Z",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 200.56,
"weightUnit": "KGM",
"lastMessageUpdate": {
"type": "INFORMATION",
"message": {
"fr-BE": "Votre commande est en cours de livraison et devrait être livrée d'ici 15h aujourd'hui",
"nl-BE": "Je bestelling is klaar voor bezorging en zou vandaag om 15u bezorgd moeten zijn"
}
},
"additionalInfo": [
{
"name": "receiver's ref",
"value": "5236776"
},
{
"name": "Sales Rep Message",
"value": "Your Order is in preparation and we dont see any issues"
},
{
"name": "carrier info",
"value": "APOLLO AS"
}
]
},
"lineItems": [
{
"lineItemId": "96122268053639168",
"quantity": 2,
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
},
{
"lineItemId": "96121848778428416",
"quantity": 2,
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
]
}
]
}
}
},
"orderAdditionalInformation": {
"cartName": "Shopping Cart",
"priceOnLogisticsNotes": true,
"purchaseOrder": "XDFG334322",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+3333333333",
"contactEmail": "john.doe@sonepar.com",
"orderConfirmationRecipients": [
"john.doe@sonepar.com",
"jane.doe@sonepar.com"
],
"notes": [
{
"noteOnInvoice": true,
"noteOnLogisticsNotes": false,
"noteText": "Morning delivery preference"
}
],
"additionalReferences": [
{
"name": "warehouseName",
"value": "Z.I. Fourviere"
}
]
},
"contributors": [
{
"fullName": "XXXX XXXXXX",
"email": "xxx@xxxxxx.com",
"creator": true
}
],
"specialPriceAgreements": [
{
"id": "SPA-876",
"title": "Special price agreement 876"
},
{
"id": "SPA-547",
"title": "Special price agreement 547"
}
],
"lineItems": [
{
"id": "96122268053639168",
"orderedQuantity": 5,
"product": {
"productId": "3618978",
"productTitle": "HID-PV C 35 35W CDM S 50-60Hz compact CDM",
"brandName": "Philips Lighting"
},
"prices": {
"netPrice": {
"amount": 4426,
"scale": 2,
"currency": "EUR"
},
"context": {
"type": "SPECIAL_PRICE_AGREEMENT",
"id": "SPA-876",
"title": "Special price agreement 876"
},
"taxes": [
{
"type": "VAT",
"percentage": 21,
"isSurcharge": false
}
]
}
},
{
"id": "96121848778428416",
"orderedQuantity": 5,
"product": {
"productId": "4408098",
"productTitle": "Master Colour CDM-T 35W G12 4200K 3000lm CRI84",
"brandName": "Philips Lighting"
},
"prices": {
"netPrice": {
"amount": 1886,
"scale": 2,
"currency": "EUR"
},
"taxes": [
{
"type": "VAT",
"percentage": 21,
"isSurcharge": false
},
{
"type": "RECUPEL",
"taxAmount": {
"amount": 826,
"scale": 4,
"currency": "EUR"
},
"isSurcharge": true
}
]
}
}
],
"paymentTerms": [
{
"paymentMethod": "CREDIT_LINE",
"amount": {
"amount": 38170,
"scale": 2,
"currency": "EUR"
}
}
]
}
An order as managed by the opco
A base order defining properties common to any kind of order
This object is used to describe some technical meta information related to the event
The application source of this event
The version of the json format event
The order id generated by the spark plateform.
"4999569661752721026"
The parent order id generated by the spark plateform, used to group spark orders associated to the same customer order.
"315627244210393088"
Tenant identifier for an Opco in SPARK multitenant platform
"BEL-CEBEO"
The Cart or the open order identifier at opco backend system level
"1234"
The Cart or the open order identifier at spark level. When known it should always be present throughout the order lifecycle. This is mandatory on online orders to activate the AX feature (used to identify abandoned cart).
"1234"
Optional field, needed by OpCo organised with a regional model or commercial organisation. It can be used to filter or route based on the orgId.
"org123"
"SNE"
The sales channel where the order is placed
"ESHOP"
The status of the order. The OpCo can send any status codes that are associated with the order in their systems. The status codes sent will need to be mapped to labels in the CMS.
"OPENED"
"VALIDATED"
"IN_PROGRESS"
"CLOSED"
The date when the order was placed
"2021-10-12T08:30:22.804Z"
The date when the order was last modified. This field will be used to ensure that only the latest update are being integrated to order history.
"2021-10-12T08:30:22.804Z"
The opco account id of the customer.
"12345"
The list of users that contribute on the creation if the cart and the order. The creator of the cart, the validator of the cart ...
No Additional Items[
{
"fullName": "John Smith",
"email": "john.smith@mycompany.com",
"creator": true
},
{
"fullName": "John Validator",
"email": "john.validator@mycompany.com"
}
]
The full name of a contributor.
"John Smith"
The email of a contributor. this is the identifier of the user on spark
"john.smith@mycompany.com"
A boolean that when is true means that the current contributor is the creator of the cart from where this order is created.
"false"
A boolean that when is true means that the current contributor has placed the order (transformed the cart to an order).
"false"
A boolean that when is true means that the current contributor has validated the cart during the approval workflow.
"false"
A boolean that when is true means that the current contributor is an associate doing the action on behalf of the end user.
"false"
The billing address
{
"opCoAddressId": "13543678",
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "1st floor",
"addressLine3": "Apparment 2",
"postalCode": "0287",
"city": "Bruges",
"region": "Frandre",
"department": "N/A",
"country": "BEL"
}
OpCo internal system's unique identifier for the address.
"237564557868778"
Should contains the Given name, Surname, the name of the company
"235 Donaghy Ave"
Should contains the street No, street name, street type
Should contains the Floor
The postal code
"V7P 1E2"
The city in which the street address is, and which is in the adminDevison(region)
"North Vancouver"
The region in which the locality is, and which is in the country.
"BC"
The department in which the locality is, and which is in the country.
"BC"
The ISO 3166-1 alpha-3 of the country
"CAN"
The address identifier from Spark system
"50169486938114"
List of special price agreements activated in this order
No Additional ItemsA special price agreement associated to an order or a price
The special price agreement identifier in the OpCo back-end system
"SPA-984"
The title of the special price agreement
"Special price agreement 984"
[
{
"id": "SPA-876",
"title": "Special price agreement 876"
},
{
"id": "SPA-547",
"title": "Special price agreement 547"
}
]
Line items that are ordered.
Must contain a minimum of 1 items
The order line item
The ID of the line item.
Must match regular expression:^[0-9]+$
"4999569661752721026"
The identifier of the line item into the opco side for the case of a cart created from a quote. It can be an alpha numeric.
"4999569661752721026"
"ITEM1"
The type of the line item, default is PRODUCT.
- PRODUCT when the line item is a product known by spark - OFFLINE_PRODUCT when the line item is a product unknown by spark
- PROMOTION when the line item is a cart promotion
- SERVICE when the line item is an extra cost or an additional service
"PRODUCT"
Number of items ordered.
10
Product data as seen by customer from the time of the order placement.
A unique identifier of the product.
- In case of promotion lineItem this should contain the id of the promotion.
"9554961192345"
global trade identifier number e.g EAN, UPC etc
"4012196097579"
This is the local product id could be specific to opcos, most cases it is same as manufacturer id but could be different as well
"732D16"
"9554961192345"
This is the equivalent of manufacturer PID and used for search and identifying the product
"1360167"
manufacturer type description identifier, represents the references
"2037 12-20 LGR"
the customer ref for the product, Supported by all special chars respecting the pattern
Must match regular expression:[a-zA-Z0-9_.+@() /$"=#,;'£\\:°*&%-]+
Short description of the product.
For PRODUCT lineItems, it is sourced from the product.identifier.productTitle field.
"LIGHT 274498 Metal Halide Lamp"
Brand name.
For PRODUCT lineItems, it is sourced from the product.identifier.brandName field.
"SASS"
Details of the promotion applied to this line item
{
"title": "Achete 3 articles et 2 gartuit",
"alternateProductId": "767867",
"campaignId": "234"
}
A readable description explaining the promotions eligibility received from opco, Send the title according to chosen language
"achetez 3 articles et obtenez 10% de réduction"
Campaign id to which this promotion is associated to relative to the standard product id
"7575785"
The alternate product id (Since promotions in cebeo is handled by maintaining 2 different id for normal and promotional product), might not be required by other opco
"9898989"
Contains the detail of prices related to the current product and line item
This is the product unit price that the customer will pay to the OPCO, without taxes, before applying promotion.
{
"amount": 1000,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Details about the type of this price
{
"type": "SPECIAL_PRICE_AGREEMENT",
"id": "SPA-876",
"title": "Special price agreement 876"
}
An identifier of the contract or project related to this price
"SPA-984"
"PROJECT-7463"
A short title for this price
"Special price agreement 984"
"Contract schneider"
The type of this price
"SPECIAL_PRICE_AGREEMENT"
"MARKETPLACE"
Percentage of discount on net price, If we have this value then promotionalNetPrice is needed also
10.0
Precomputed promotional price on top of netPrice, This is the case when promotional percentage is not present and the promotional price is directly computed and available to show
{
"amount": 200,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Precomputed quote price on top of netPrice. This is the case when the cart is created from a quote and the OPCO give a preferential price for the product.
{
"amount": 900,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
List of taxes to be applied to net price or promotional net price in case of promotion
No Additional ItemsContains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesContains the amount informations based on the type of prices we might have
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
[
{
"type": "VAT",
"isSurcharge": false,
"percentage": 20.0
}
]
The comment is added to line item by the customer during the order placement. It is used by the customer to provide any information to be received by their own team when the order is delivered.
"Please place this item on 3rd floor"
Contains marketplace properties specific to this lineItems, once set these are assumed to be immutable.
The identifier of this lineItem in the opco purchase order
Purchase unit price (computed by the marketplace platform from the commission rate and the provided offer price)
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The id of a cut group, groups several cutting lines
"10"
Cutting line identifier, group of elements with the same cutting length
"1"
[
{
"id": "4999569661752721000",
"orderedQuantity": 10,
"product": {
"productId": "4999569661752721000",
"productTitle": "SIEMENS Circuit Breaker",
"brandName": "Siemens"
},
"prices": {
"netPrice": {
"amount": 1000,
"scale": 2,
"currency": "EUR"
},
"promotionalNetPrice": {
"amount": 900,
"scale": 2,
"currency": "EUR"
},
"taxes": [
{
"type": "VAT",
"isSurcharge": false,
"percentage": 20.0
}
]
}
}
]
List of coupon added to the cart.
Must contain a minimum of 1 items
This object represent a coupon into cart
- when the coupon will be added by the user the request will contains only the code
- if the coupon is not valid, we expect the opco to send a message with severity ERROR to inform the user
- if the coupon is valid but condition are not yet reached (more product should be added), we expect the opco to send a message with severity INFO
- if the coupon is valid and a discount have to be applied, we expect the opco to set the discount amount
- if the coupon have to be applied alone the exclusive should be set to true
A unique identifier of a coupon
A readable description explaining the details of this coupons eligibility received from opco, Send the title according to chosen language
The discount applied by this coupon
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Used in case of coupon.
- When true no coupon can be applied with this one.
- When false other coupon can be applied with this one.
Payment terms associated with the order
No Additional ItemsTerms and conditions by which a payment has been or will be made.
The payment method type
"CREDIT_LINE"
The transaction payment id
"PAY0001"
The amount of the payment
{
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Date on which the payment transaction has been created
"2017-07-21T08:30:22.804Z"
[
{
"paymentMethod": "CREDIT_LINE",
"amount": {
"amount": 10000,
"scale": 2,
"currency": "EUR"
},
"paymentTransactionId": "12345",
"createdAt": "2017-07-21T17:32:28Z"
}
]
The total price of all items of the order applying promotions and coupons, including all taxes.
{
"amount": 17760,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all items of the order including promotions and including surcharges.
{
"amount": 17760,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Additional information for the order.
Order reference for the customer (ex: customer purchase order id).
"XDFG334322"
The cart name.
"Site 1 Cart"
The project associated to the order
The identifier of the project
The name of the project to display to the customer
The quote associated to the order
The identifier of the quote
"4999569661752721026"
"4999569661_ORG1"
The quote code provided by the OpCo for the Customer. If this field is provided, spark will display it to the customer instead of the quoteId
"49995666"
"4999569661"
The name of the Quote.
The version of this quote. Used by some opco system to select the right version of the quote.
"1"
The type of the quote. STANDARD for normal quotes, BLANKET for quote representing blanket orders. Default value if not present is STANDARD.
"STANDARD"
Contact first name for this order. This field is added by the customer to override the same field into delivery address.
"Robert"
Contact last name for this order. This field is added by the customer to override the same field into delivery address.
"Fox"
Contact phone number for this order. This field is added by the customer to override the same field into delivery address.
"+3333333333"
Contact email for this order.
"john.doe@sonepar.com"
Choice of showing or not the price on the logistics note.
false
An optional emails list that will be used as additional recipients to send the confirmation email of the order
No Additional ItemsThe notes related to the order.
No Additional ItemsObject representing a note
Choice of showing or not the note on the invoice.
true
Choice of showing or not the note on the logistics notes.
false
Note added to cart
"Morning delivery preference"
[
{
"noteOnInvoice": true,
"noteOnLogisticsNotes": false,
"noteText": "Morning delivery preference"
}
]
Additional order information filled by the customer when placing the order or added by the OpCo system during the order processing.
No Additional ItemsObject representing an additional reference.
Name of the additional reference
"warehouseName"
Value of the additional reference filled by the customer
"P570629"
[
{
"name": "warehouseName",
"value": "Z.I. Fourviere"
}
]
This property if present acts as a flag to identify an order as a marketplace one. It contains all marketplace specific order properties.
No Additional PropertiesIdentifier of the purchase order to be sent by the OpCo to the Seller.
It is not to be confused with the customer purchaseOrder defined as part of the additional order information, which is an an optional identifier of the order as referenced by the customer.
Contains seller information
OpCo SellerId, as provided operator internal id for this seller.
Seller name
The IETF BCP 47 language tag of the locale (language and country) as used by the customer on spark front-end for this order.
"fr-FR"
Defines additional fields specific to OpCo Orders
No Additional PropertiesThe order id known by the opco and the customer. Two orders can't have the same Id
"4999569661752721026"
"49995696_ORG1"
The list of logistic details related to this order
Must contain a minimum of 1 items
Information about the logistic details of the current cart (logistic method, logistic preferences, logistic options, delivery address, facility id)
{
"logisticMethod": "DELIVERY",
"facilityId": 395,
"deliveryAddress": {
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
},
"logisticOption": {
"code": "STANDARD",
"title": "STANDARD delivery",
"description": "Choose this option if you want a fast delivery",
"cost": {
"amount": 1,
"scale": 2,
"currency": "EUR"
},
"logisticScenario": {
"code": "1_DELIVERY",
"title": "1 DELIVERY",
"description": "Choose this scenario if you want all your products to be delivered at the same time",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"shippingGroups": [
{
"status": "SHIPPED",
"deliveryDate": "2022-05-21T08:30:22.804Z",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 187.5,
"weightUnit": "KGM",
"lastMessageUpdate": {
"type": "INFORMATION",
"message": {
"fr-BE": "Votre commande est en cours de livraison et devrait être livrée d'ici 15h aujourd'hui",
"nl-BE": "Je bestelling is klaar voor bezorging en zou vandaag om 15u bezorgd moeten zijn"
}
},
"additionalInfo": [
{
"name": "carrier link",
"value": "www.ups.com"
},
{
"name": "Sales Rep Message",
"value": "Your Order is in preparation and we dont see any issues"
},
{
"name": "carrier info",
"value": "APOLLO AS"
}
]
},
"lineItems": [
{
"quantity": 1,
"lineItemId": "1",
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
],
"alternativeLogisticDetails": {
"logisticMethod": "DELIVERY",
"facilityId": "11223344"
}
}
]
}
}
}
Logistic method chosen for the cart
"PICK_UP"
Unique identifier of the locker related to the 'facilityId' where the customer want pick up his order. The facilityId still the place where the order will be prepared
"395"
Unique identifier of the facility used when logistic method is 'PICK_UP'.
"395"
The id of the CDC from where this cart should be delivered. Needed to compute the right stock into PLP/PDP ....In case of multi CDC, the OpCo may have dynamic computation of the CDC and not only a static relation between branch and CDC.
"2Z1"
The address used for delivery when logistic method is 'DELIVERY'
An address.
OpCo internal system's unique identifier for the address.
"237564557868778"
Should contains the Given name, Surname, the name of the company
"235 Donaghy Ave"
Should contains the street No, street name, street type
Should contains the Floor
The postal code
"V7P 1E2"
The city in which the street address is, and which is in the adminDevison(region)
"North Vancouver"
The region in which the locality is, and which is in the country.
"BC"
The department in which the locality is, and which is in the country.
"BC"
The ISO 3166-1 alpha-3 of the country
"CAN"
The address identifier from Spark system
"50169486938114"
Represents additional fields of the delivery address
Extra description about the address
"Building site 1"
Company name, it might differ from the account name
"Easy Electric"
Address contact's first name
"John"
Address contact's last name
"Doe"
Address contact's Phone number (The phone number of the person receiving the shipment)
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
{
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
}
The logistic option chosen for the selected logistic method (e.g a standard delivery is a logistic option).
{
"code": "STANDARD",
"title": "STANDARD delivery",
"description": "Choose this option if you want a fast delivery",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"logisticScenario": {
"code": "1_DELIVERY",
"title": "1 DELIVERY",
"description": "Choose this scenario if you want all your products to be delivered at the same time",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"totalPrice": {
"amount": 2300,
"scale": 2,
"currency": "EUR"
},
"totalPriceIncludingSurchargesAndShipping": {
"amount": 1900,
"scale": 2,
"currency": "EUR"
},
"shippingGroups": [
{
"status": "IN_PREPARATION",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 200,
"weightUnit": "GRM",
"estimatedDeliveryDate": "2021-10-12T08:30:22.804Z",
"lastMessageUpdate": {
"type": "WARNING",
"message": {
"fr-BE": "certains produits que vous avez commandés ne sont pas disponibles et seront livrés à la date de livraison estimée, veuillez contacter votre représentant commercial pour plus d'informations",
"nl-BE": "sommige producten die u hebt besteld, zijn niet beschikbaar en worden geleverd op de geschatte leverdatum. Neem contact op met uw verkoper voor meer informatie"
}
}
},
"lineItems": [
{
"quantity": 1,
"lineItemId": "1",
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
],
"alternativeLogisticDetails": {
"logisticMethod": "DELIVERY",
"facilityId": "11223344",
"deliveryAddress": {
"opCoAddressId": "1234567890",
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
}
}
}
]
}
}
The code of the logistic option
"STANDARD"
The title of the logistic option to be displayed to the end user.
"STANDARD delivery"
The description of the logistic option to be displayed to the end user.
"choose this option if you want a fast delivery"
The cost of this logistic option
{
"amount": 0,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
This is the chosen logistic scenarios from the ones available for the current logistic option.(e.g deliver all the products at the same time is a logistic scenario)
{
"selected": true,
"code": "1_DELIVERY",
"title": "1 DELIVERY",
"description": "Choose this scenario if you want all your products to be delivered at the same time",
"cost": {
"amount": 0,
"scale": 2,
"currency": "EUR"
},
"totalPrice": {
"amount": 2300,
"scale": 2,
"currency": "EUR"
},
"totalPriceIncludingSurchargesAndShipping": {
"amount": 1900,
"scale": 2,
"currency": "EUR"
},
"shippingGroups": [
{
"status": "SHIPPED",
"deliveryDate": "2021-10-12T08:30:22.804Z",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 200,
"weightUnit": "GRM",
"lastMessageUpdate": {
"type": "INFORMATION",
"message": {
"fr-BE": "Votre commande est en cours de livraison et devrait être livrée d'ici 15h aujourd'hui",
"nl-BE": "Je bestelling is klaar voor bezorging en zou vandaag om 15u bezorgd moeten zijn"
}
},
"additionalInfo": [
{
"name": "receivers ref",
"value": "5236776"
},
{
"name": "Sales Rep Message",
"value": "Your Order is in preparation and we dont see any issues"
},
{
"name": "carrier info",
"value": "APOLLO AS"
}
]
},
"lineItems": [
{
"quantity": 1,
"lineItemId": "1",
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
]
}
]
}
The code of the logistic scenario
"1_DELIVERY"
The title of the logistic scenario to be displayed to the end user.
"1 DELIVERY"
The description of the logistic scenario to display to the end user.
"choose this scenario if you want all your products to be delivered at the same time"
The cost of this logistic scenario
{
"amount": 0,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Total price of the logistic scenario including promotions, surcharges, shipping cost and taxes (vat)
{
"amount": 0,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Total price of the logistic scenario including promotions, surcharges, shipping cost without taxes (vat)
{
"amount": 0,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
A list of groups of line items corresponding to the way the order will be fulfilled
No Additional ItemsOrder shipment
The status of the shipping group.
OpCos can send any status supported by their backend system.
The status codes sent are mapped to labels in the CMS and displayed as how customers want to see these status on CX UI without stepper.
Only exception for that, the following status:
- When CX push the order shipping groups will have the status OPENED
- For cancelled lineItems, a shipping group with a status value CANCELLED is expected.
- For back ordered lineItems, a shipping group with a status value BACK_ORDERED is expected.
To enable the track and trace CX feature, where a stepper is displayed and notifications are sent to the user when status are changing, the OpCos have to send the following normalised status list:
- ACCEPTED for the orders first validation or acceptance by OpCo
- REJECTED status should be used when (part of) the order is refused (not ACCEPTED)
- IN_PREPARATION for the orders in preparation until they are shipped
- SHIPPED for all the orders Shipped and in Transit
- DELIVERED for all the orders delivered at source
- AVAILABLE_FOR_PICKUP status should be used in PICKUP when the order is ready to be picked up in branch
- AVAILABLE_IN_LOCKER status should be used in PICKUP when the order is ready to be picked up in locker
- COLLECTED status should be used in PICKUP when the order has been collected from branch or locker.
NOTE:
Using status codes, which are not part of the list above in track and trace section will be displayed without the stepper and no track and trace notifications will be triggered..
"ACCEPTED"
"IN_PREPARATION"
"SHIPPED"
"DELIVERED"
"CANCELLED"
"BACK_ORDERED"
"OPENED"
"AVAILABLE_FOR_PICKUP"
"AVAILABLE_IN_LOCKER"
"COLLECTED"
"REJECTED"
Will be true if the delivery date is selected by the customer. It will be false is the date is the one computed by the opco backend system.
[Deprecated - Use instead expectedDeliveryDate and expectedDeliveryTime].
Date on which the shipment expected to be delivered.
"2021-10-12T08:30:22.804Z"
Date on which the shipment expected to be delivered.
"2021-10-12"
Time on which the shipment expected to be delivered
"08:30:22.804Z"
Used only on Marketplace context Latest date on which the shipment is expected to be delivered.
"2021-10-12"
Used only on Marketplace context Latest time on which the shipment is expected to be delivered.
"08:30:22.804Z"
This object contains the details of tracking the delivery
The number of packages to be delivered
5
The total weight of all packages to be delivered
200
The units in which the weights are computed and displayed following the GS1 units of measure
"KGM"
A type and message object, where type is Info or Warning and message is the actual update
The type of the message whether its info or warning
"INFORMATION"
The actual message for the last update
{
"fr-BE": "Votre commande est en cours de livraison et devrait être livrée d'ici 15h aujourd'hui",
"nl-BE": "Je bestelling is klaar voor bezorging en zou vandaag om 15u bezorgd moeten zijn"
}
Each additional property must conform to the following schema
Type: stringIf there is an issue or delay then last message update is an apology message with new estimated delivery date
"2021-10-12T08:30:22.804Z"
Any additional info related to this delivery
No Additional ItemsA free key value pair field to add any specific messages or details
The name or identifier for an additional info
"receivers ref"
"senders ref"
"carrier name"
"additional instructions"
The value for the named additional info
"6868686"
"24424"
"APOLLO AS"
This object contains the logistic details associated with the shipping groupin cases where additional logistic details are applicable. e.g Logistic Details / Facility for each shipping intent group to support multi-cdc delivery.
{
"logisticMethod": "DELIVERY",
"facilityId": "11223344",
"deliveryAddress": {
"opCoAddressId": "1234567890",
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
}
}
{
"logisticMethod": "DELIVERY",
"facilityId": "11223344"
}
OpCo internal system's unique identifier for the address.
The id of the facility (branch or CDC) associated with the logistic details
"AB2"
The delivery address associated to the account where the order should be delivered.
An address.
OpCo internal system's unique identifier for the address.
"237564557868778"
Should contains the Given name, Surname, the name of the company
"235 Donaghy Ave"
Should contains the street No, street name, street type
Should contains the Floor
The postal code
"V7P 1E2"
The city in which the street address is, and which is in the adminDevison(region)
"North Vancouver"
The region in which the locality is, and which is in the country.
"BC"
The department in which the locality is, and which is in the country.
"BC"
The ISO 3166-1 alpha-3 of the country
"CAN"
The address identifier from Spark system
"50169486938114"
Represents additional fields of the delivery address
Extra description about the address
"Building site 1"
Company name, it might differ from the account name
"Easy Electric"
Address contact's first name
"John"
Address contact's last name
"Doe"
Address contact's Phone number (The phone number of the person receiving the shipment)
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
{
"opCoAddressId": "1234567890",
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
}
The line items that are shipped.
No Additional ItemsOptional. The line items that are shipped.
No Additional PropertiesA reference to a line item. This field is a 64-bit long number represented as a string to avoid unwanted conversions to scientific notation when dealing with the model inside js code
Must match regular expression:^[0-9]+$
"2196602318024039368"
The quantity that is shipped.
1
This is the line item price that the customer will pay to the OPCO, without taxes, after applying promotion. Equals (unitPrice * quantity) for items without promotion or (discountedUnitPrice * quantity) for items with promotion
{
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
This is the shipping cost for this line item, provided when known. The logistic scenario cost should be equal to the sum of all lineItems shipping cost from all (non canceled) shipping group.
{
"amount": 200,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
This is the list of taxes applicable to this lineItem, amounts are total taxes amounts for this lineItem. It includes surchages (isSurchage:true), taxes on the (itemPrice + surchages), taxes on shippingCosts (isShipping:true).
Contains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesContains the amount informations based on the type of prices we might have
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
[
{
"type": "VAT",
"code": "tax-fra-55",
"taxAmount": {
"amount": 550,
"scale": 2,
"currency": "EUR"
},
"percentage": 5.5
},
{
"type": "ECOTAXE1",
"isSurcharge": true,
"taxAmount": {
"amount": 1500,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "ECOTAXE2",
"isSurcharge": true,
"taxAmount": {
"amount": 500,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "VAT",
"code": "tax-fra-20",
"isShipping": true,
"taxAmount": {
"amount": 20,
"scale": 2,
"currency": "EUR"
},
"percentage": 20
}
]
Additional information only present in marketplace shippingGroups. These order line attributes can be updated throughout the order lifecycle.
Purchase order line’s commission fee. Equals (itemPrice + surchages) * commission_rate
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Purchase order line’s commission fee on shipping. Equals line item shippingCost * commision_rate_on_shipping
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Purchase order line’s price excluding shipping charges. Equals (itemPrice + surchages) - purchaseCommissionOnPrice
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Purchase order line’s shipping charges. Equals line item shippingCost - purchaseCommissionOnShipping
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Purchase order line's taxes. The list of taxes matches the itemTaxes but for the purchase order
No Additional ItemsContains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesContains the amount informations based on the type of prices we might have
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
[
{
"quantity": 4,
"lineItemId": "1",
"itemPrice": {
"amount": 4000,
"scale": 2,
"currency": "EUR"
},
"shippingCost": {
"amount": 1000,
"scale": 2,
"currency": "EUR"
},
"itemTaxes": [
{
"type": "VAT",
"code": "tax-fra-55",
"taxAmount": {
"amount": 2640,
"scale": 2,
"currency": "EUR"
},
"percentage": 5.5
},
{
"type": "ECOTAXE1",
"isSurcharge": true,
"taxAmount": {
"amount": 150,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "ECOTAXE2",
"isSurcharge": true,
"taxAmount": {
"amount": 50,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "VAT",
"code": "tax-fra-20",
"isShipping": true,
"taxAmount": {
"amount": 200,
"scale": 2,
"currency": "EUR"
},
"percentage": 20
}
],
"marketplace": {
"purchaseCommissionOnPrice": {
"amount": 960,
"scale": 2,
"currency": "EUR"
},
"purchaseCommissionOnShipping": {
"amount": 200,
"scale": 2,
"currency": "EUR"
},
"purchaseNetPrice": {
"amount": 3840,
"scale": 2,
"currency": "EUR"
},
"purchaseShippingPrice": {
"amount": 800,
"scale": 2,
"currency": "EUR"
},
"purchaseItemTaxes": [
{
"type": "VAT",
"code": "tax-fra-55",
"taxAmount": {
"amount": 2112,
"scale": 3,
"currency": "EUR"
},
"percentage": 5.5
},
{
"type": "ECOTAXE1",
"isSurcharge": true,
"taxAmount": {
"amount": 1500,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "ECOTAXE2",
"isSurcharge": true,
"taxAmount": {
"amount": 500,
"scale": 2,
"currency": "EUR"
}
},
{
"type": "VAT",
"code": "tax-fra-20",
"isShipping": true,
"taxAmount": {
"amount": 160,
"scale": 2,
"currency": "EUR"
},
"percentage": 20
}
]
}
}
]
Documents references associated with this shipping group
No Additional ItemsInformation identifying a document and potentially a line within the document for referencing purposes.
The type of the document
"INVOICE"
The id of the document
"4999569661752721026"
Date on which the document has been created, in ISO 8601 format.
"2017-07-21T08:30:22.804Z"
System/component where the document is to be sourced from.
"MARKETPLACE"
"OPCO"
[
{
"type": "DELIVERY_NOTES",
"id": "4999569661752721026",
"createdAt": "2017-07-21T17:32:28Z"
}
]
Identifier that identify the logisticOrder generated and provided by the OpCo
"s01242"
"298"
[
{
"status": "SHIPPED",
"deliveryDate": "2021-10-12T08:30:22.804Z",
"trackAndTraceInfo": {
"numberOfPackages": 5,
"totalWeight": 200,
"weightUnit": "KGM",
"lastMessageUpdate": {
"type": "INFORMATION",
"message": {
"fr-BE": "Votre commande est en cours de livraison et devrait être livrée d'ici 15h aujourd'hui",
"nl-BE": "Je bestelling is klaar voor bezorging en zou vandaag om 15u bezorgd moeten zijn"
}
},
"additionalInfo": [
{
"name": "receiver's ref",
"value": "5236776"
},
{
"name": "Sales Rep Message",
"value": "Your Order is in preparation and we dont see any issues"
},
{
"name": "carrier info",
"value": "APOLLO AS"
}
]
},
"lineItems": [
{
"quantity": 1,
"lineItemId": "1",
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
]
}
]
The total amount of all the items of the order after applying promotions,shipping cost and coupons, without taxes.
{
"amount": 13800,
"scale": 2,
"currency": "EUR"
}
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total amount of each tax.
Total tax amounts should be grouped by (type, percentage) to cover the case of different percentages for the same taxe type.
Contains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesContains the amount informations based on the type of prices we might have
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
[
{
"type": "VAT",
"isSurcharge": false,
"taxAmount": {
"amount": 12000,
"scale": 4,
"currency": "EUR"
},
"percentage": 20
},
{
"type": "VAT",
"isSurcharge": false,
"taxAmount": {
"amount": 100,
"scale": 4,
"currency": "EUR"
},
"percentage": 5.5
},
{
"type": "ECOTAXE",
"isSurcharge": true,
"taxAmount": {
"amount": 260,
"scale": 2,
"currency": "EUR"
}
}
]
Documents references associated with the order
No Additional ItemsInformation identifying a document and potentially a line within the document for referencing purposes.
The type of the document
"INVOICE"
The id of the document
"4999569661752721026"
Date on which the document has been created, in ISO 8601 format.
"2017-07-21T08:30:22.804Z"
System/component where the document is to be sourced from.
"MARKETPLACE"
"OPCO"
[
{
"type": "INVOICE",
"id": "4999569661752721026",
"createdAt": "2017-07-21T17:32:28Z"
},
{
"type": "DELIVERY_NOTES",
"id": "234098230957209357",
"createdAt": "2023-03-03T18:52:00Z",
"source": "MARKETPLACE"
}
]
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
Order Ids for marketplace products have a constraint on the allowed pattern
^[a-zA-Z0-9\-_]*$