This schema is used internally by Spark, not for OpCo integration.
Object that will be enriched for document export
This schema is used internally by Spark, not for OpCo integration.
Object that will be enriched for document export
The unique identifier for the document to export
"1097632349443"
Id of the user
Must match regular expression:^[0-9]+$
"776544"
OpCo internal system's unique identifier for the account.
Must match regular expression:^(?=\s*\S).*$
"776544"
Operating company's unique identifier
"BEL-CEBEO"
Commercial organization identifier
Must match regular expression:^(?=\s*\S).*$
"CO1"
Locale intended to identify current user language
"fr-BE"
format of the exported document
"PDF"
Set of permissions of customer requiring document export
No Additional ItemsEnumeration of permission available in the Spark platform.
"VIEW_NET_PRICE"
"MANAGE_USERS"
"CONTRIBUTE_CART"
This object contains all the optional fields that could be needed in input
Cart identifier
Must match regular expression:^[0-9]+$
"17050283147243520"
An array of product identifiers that will be used as input to fill the product section
No Additional ItemsAn array of the opco identifier of the credit note or the invoice.
No Additional ItemsOrder identifier
Must match regular expression:^[0-9]+$
No Additional Items"17050283147243520"
An array Facility identifier that will be used as input to fill the facility section
No Additional ItemsAn array User identifier that will be used as input
No Additional ItemsAn array User identifier that will be used as input
No Additional ItemsCart id. 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]+$
"17050283147243520"
Cart name. If the name is not filled in, its value will be set to "Shopping Cart".
"Shopping Cart."
Cart status:
* IN_PROGRESS - The most common status for a cart during most of its ‘lifecycle'. The cart can be modified.
* APPROVAL_REQUIRED - Short term status. A contributor will request the approval for the cart once she/he has finished the constitution. If the cart approval request is declined the cart go back to in progress. When approval is requested, the cart cannot be modified by the contributor, however, it could be modified by the validator.
* APPROVED - The cart has been approved by a user - which allows to progress to the payment process in checkout for a user with appropriate permissions. The cart cannot be modified.
* TRANSACTION_IN_PROGRESS - The cart is submitted to a transaction which will lead to payment and order propagation or alternatively to a failed payment. The cart cannot be modified.
* BULK_ADD_IN_PROGRESS - a bulk add of items to the cart is in progress. The cart cannot be modified.
* AT_COUNTER - The cart is submitted to sales rep when the mode is IN_STORE. The cart cannot be modified.
"IN_PROGRESS"
OpCo account's identifier from which the cart is created.
Must match regular expression:^(?=\s*\S).*$
"4999569661752721026"
Commercial organization identifier. Only present if the account includes one.
Must match regular expression:^(?=\s*\S).*$
"4999569661752721026"
Creation date time of the cart
"2020-10-12T08:30:22.804528Z"
Last modification date time of the cart
"2020-10-12T08:30:22.804528Z"
Last date-time of cart rich synchronization with Opco ERP
"2020-10-12T08:30:22.804528Z"
Address to which the billing information would be sent
{
"addressLine1": "chaussée Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
Information about the logistic details of the current cart (logistic method, logistic preferences, logistic options, delivery address, facility id)
Logistic method chosen for the cart
"PICK_UP"
List of supported logistic methods for the current cart. This field is temporary and should only be used in agreement with the C&C team
Must contain a minimum of 1 items
"PICK_UP"
"DELIVERY"
Unique identifier of the consolidated distribution center facility from which the order will be delivered
"cdc_erp_id_1"
Unique identifier of the facility
"395"
description: Name of the facility used
"SONEPAR Facility"
Id of the marketplace seller
"2012"
Name of the marketplace seller
"Ampoules Cools"
Id of the opco seller
"2010"
The address used for delivery when logistic method is 'DELIVERY'
{
"addressLine1": "chaussée Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
the list of logistic options available for the selected logistic method
No Additional ItemsA logistic option available for the selected logistic method
This boolean will be true if the logistic option was selected by the customer or it was selected by the opco as the recommended one
true
false
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
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
this is a list of logistic scenarios available for the current logistic option.(e.g deliver all the products at the same time is a logistic scenario)
No Additional Itemslogistic scenario available for the current logistic option
This boolean will be true if the logistic option was selected by the customer or it was selected by the opco as the recommended one
true
false
The code of the logistic option
"1_DELIVERY"
The title of the logistic option to be displayed to the end user
"1_DELIVERY"
The description of the logistic option to be displayed to the end user
"choose this scenario if you want all your products to be delivered at the same time"
The pick up mode of the current scenario. This field could be filled when the logisticMethod is PICK_UP
"LOCKER"
The cost of this logistic scenario
{
"amount": 5,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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 cart will be fulfilled
No Additional Itemslogistic scenario available for the current logistic option
The id of the shippingIntentGroup
1
Additional information about the shipping intent group
"Pick up available 24/7, call the lobby 1 hour before"
The expected pickup/delivery date in ISO-8601 format of this shipping group proposed by the opco
"2021-07-23"
The expected delivery time in ISO-8601 format of this shipping group proposed by the opco. The time is in UTC timezone
"08:30:00.804528Z"
The custom pickup/delivery date in ISO-8601 format chosen by the user for this shipping group
"2021-07-24"
This object contains the logistic details of the facility in cases where additional logistic details are applicable current option. e.g Facility for each shipping intent group to support multi-cdc delivery
The logistic method in case when this logistic information is to be shown to the end user even if the logistic method choice made is different e.g - User chooses delivery but also sees the express PICK UP option and vice versa
"DELIVERY"
The alternative facility id
"205987"
The alternative delivery address
{
"addressLine1": "chaussée Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
a list of line items part of this shipping group
No Additional Itemsa line item belonging to a shippingIntentGroup
a 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
"2196602318024039368"
Unique product identifier for a product. Could be a gtin, EAN, UPC, skuid ...
"3675925"
the quantity of this line item on this shipping group
2
{
"lineItemId": "2196602318024039368",
"productId": "3675925",
"quantity": 2
}
{
"id": 1,
"expectedAvailabilityDate": "2021-07-23",
"expectedAvailabilityTime": "08:30:00.804528Z",
"customAvailabilityDate": "2021-07-24",
"lineItems": [
{
"lineItemId": "2196602318024039368",
"productId": "3675925",
"quantity": 2
}
]
}
The total price of all items added to the cart after applying promotions, including surcharges and shipping costs related to current scenario. This field is included in the response only if it is calculated by the opcos when performing a rich synchronization
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all items added to the cart after applying promotions, including surcharges, taxes and shipping costs related to current scenario. This field is included in the response only if it is calculated by the opcos when performing a rich synchronization
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
This object contains the alternative logistic details of the current option. e.g Express pick up at CDC requires facility id etc
The logistic method in case when this logistic information is to be shown to the end user even if the logistic method choice made is different e.g - User chooses delivery but also sees the express PICK UP option and vice versa
"DELIVERY"
The alternative facility id
"205987"
The alternative delivery address
{
"addressLine1": "chaussée Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
list of logistic details regarding marketplace products
No Additional ItemsInformation about the logistic details of the current cart (logistic method, logistic preferences, logistic options, delivery address, facility id)
Logistic method chosen for the cart
"PICK_UP"
List of supported logistic methods for the current cart. This field is temporary and should only be used in agreement with the C&C team
Must contain a minimum of 1 items
"PICK_UP"
"DELIVERY"
Unique identifier of the consolidated distribution center facility from which the order will be delivered
"cdc_erp_id_1"
Unique identifier of the facility
"395"
description: Name of the facility used
"SONEPAR Facility"
Id of the marketplace seller
"2012"
Name of the marketplace seller
"Ampoules Cools"
Id of the opco seller
"2010"
The address used for delivery when logistic method is 'DELIVERY'
{
"addressLine1": "chaussée Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
the list of logistic options available for the selected logistic method
No Additional ItemsA logistic option available for the selected logistic method
This boolean will be true if the logistic option was selected by the customer or it was selected by the opco as the recommended one
true
false
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
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
this is a list of logistic scenarios available for the current logistic option.(e.g deliver all the products at the same time is a logistic scenario)
No Additional Itemslogistic scenario available for the current logistic option
This boolean will be true if the logistic option was selected by the customer or it was selected by the opco as the recommended one
true
false
The code of the logistic option
"1_DELIVERY"
The title of the logistic option to be displayed to the end user
"1_DELIVERY"
The description of the logistic option to be displayed to the end user
"choose this scenario if you want all your products to be delivered at the same time"
The pick up mode of the current scenario. This field could be filled when the logisticMethod is PICK_UP
"LOCKER"
The cost of this logistic scenario
{
"amount": 5,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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 cart will be fulfilled
No Additional Itemslogistic scenario available for the current logistic option
The id of the shippingIntentGroup
1
Additional information about the shipping intent group
"Pick up available 24/7, call the lobby 1 hour before"
The expected pickup/delivery date in ISO-8601 format of this shipping group proposed by the opco
"2021-07-23"
The expected delivery time in ISO-8601 format of this shipping group proposed by the opco. The time is in UTC timezone
"08:30:00.804528Z"
The custom pickup/delivery date in ISO-8601 format chosen by the user for this shipping group
"2021-07-24"
This object contains the logistic details of the facility in cases where additional logistic details are applicable current option. e.g Facility for each shipping intent group to support multi-cdc delivery
The logistic method in case when this logistic information is to be shown to the end user even if the logistic method choice made is different e.g - User chooses delivery but also sees the express PICK UP option and vice versa
"DELIVERY"
The alternative facility id
"205987"
The alternative delivery address
{
"addressLine1": "chaussée Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
a list of line items part of this shipping group
No Additional Itemsa line item belonging to a shippingIntentGroup
a 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
"2196602318024039368"
Unique product identifier for a product. Could be a gtin, EAN, UPC, skuid ...
"3675925"
the quantity of this line item on this shipping group
2
{
"lineItemId": "2196602318024039368",
"productId": "3675925",
"quantity": 2
}
{
"id": 1,
"expectedAvailabilityDate": "2021-07-23",
"expectedAvailabilityTime": "08:30:00.804528Z",
"customAvailabilityDate": "2021-07-24",
"lineItems": [
{
"lineItemId": "2196602318024039368",
"productId": "3675925",
"quantity": 2
}
]
}
The total price of all items added to the cart after applying promotions, including surcharges and shipping costs related to current scenario. This field is included in the response only if it is calculated by the opcos when performing a rich synchronization
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all items added to the cart after applying promotions, including surcharges, taxes and shipping costs related to current scenario. This field is included in the response only if it is calculated by the opcos when performing a rich synchronization
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
This object contains the alternative logistic details of the current option. e.g Express pick up at CDC requires facility id etc
The logistic method in case when this logistic information is to be shown to the end user even if the logistic method choice made is different e.g - User chooses delivery but also sees the express PICK UP option and vice versa
"DELIVERY"
The alternative facility id
"205987"
The alternative delivery address
{
"addressLine1": "chaussée Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
The cart or the open order identifier at opco system level
"cart-1615220019126"
Special price agreements
No Additional ItemsSpecial price agreement
Identifier of the special price agreement
"47384781"
Title of the special price agreement
"SPA 1 cheaper than base and SPA 2"
{
"id": "47384781",
"title": "SPA 1 cheaper than base and SPA 2"
}
{
"id": "47384782",
"title": "SPA 2 cheaper than base but more expensive than SPA 2"
}
The project associated to the cart
Unique identifier of the project
"47384783"
The name of the project
"StandElec project"
The quote associated to the cart
Unique identifier of the quote
"quote-001"
The name of the quote
"Quote 001"
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"
The version of this quote. Used by some opco system to select the right version of the quote.
"1"
list of items added to the cart. Last added item is in the top
No Additional ItemsThis object represent a product item into cart
Unique Id to identify an item's occurrence in the cart. 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 identifier of the line item within the quote in the OpCo system. It can be an alpha numeric value.
"4999569661752721026"
Different types of line items :
* PRODUCT - when the item contains a product available in spark catalog
* OFFLINE_PRODUCT - when the item contains a product not available in spark catalog
* PROMOTION - when the line item is a cart promotion
"PRODUCT"
A flag to identify whether the item was added from spark or during the synchronization with opco. An item with null source should be considered as an item added from spark
"SPARK"
Unique product identifier for a product. Could be a gtin, EAN, UPC, skuid ...
"3675925"
Details of the offline product. This property exists only if itemType is OFFLINE_PRODUCT
{
"brandName": "Legrand",
"productTitle": "BATTERY CABINETS"
}
The brand of the offline product
"Legrand"
The title of the offline product, according the selected language of the customer (Accept-Language)
"BATTERY CABINETS"
number of units added to the cart.
2
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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Promotion percentage for the net price. No promotion percentage means there is either no promotion, or the promotion is not based on a promotion percentage.
10
This is the product unit price that the customer will pay to the OPCO, without taxes, after applying promotion. No promotional net price on the response means that no promotion is applied to the product
{
"amount": 900,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Details of the promotion applied to this item
{
"campaignId": "7575785",
"title": "10% de réduction jusqu'à épuisement du stock",
"alternateProductId": "9898989"
}
Campaign id to which this promotion is associated
"7575785"
A human readable description explaining the promotions eligibility according to chosen language
"Achetez 3 articles et obtenez 10% de réduction"
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 opcos
"9898989"
This is the product unit price that the customer will pay, without taxes, after applying the quote discount.
{
"amount": 900,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Special price agreement applied to this item
{
"id": "47384781",
"title": "SPA 1 cheaper than base and SPA 2"
}
Identifier of the special price agreement
"47384781"
Title of the special price agreement
"SPA 1 cheaper than base and SPA 2"
Details about the type of this price.
{
"id": "47384781",
"title": "SPA 1 cheaper than base and SPA 2",
"type": "SPECIAL_PRICE_AGREEMENT"
}
an identifier of the contract or project related to this price
"7575785"
A short title for this price according the selected language of the customer (Accept-Language)
"Contract schneider"
The type of this price when set to
- SPECIALPRICEAGREEMENT the id field should contains the contractId
- PROJECT the id field should contains the projectId
- STANDARD the id field can contains any identifier of this price, example the contractId (DEFAULT)
"SPECIAL_PRICE_AGREEMENT"
List of taxes to be applied to net price or promotional net price in case of promotion
No Additional ItemsContains information about a tax. May contain a percentage or a taxAmount or both.
The type of the tax.
"VAT"
Is the tax applied as a surcharge or not (non-surcharge taxes apply to the price including surcharges).
false
Amount of the tax
{
"amount": "2160",
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Percentage of the tax
20
{
"type": "VAT",
"surcharge": false,
"percentage": 20
}
This is the line item price that the customer will pay to the OPCO, without taxes, after applying promotion. Equals (netPrice * quantity) for items without promotion or (promotionalNetPrice * quantity) for items with promotion
{
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
List of taxes to be applied to item price
No Additional ItemsContains information about a tax. May contain a percentage or a taxAmount or both.
The type of the tax.
"VAT"
Is the tax applied as a surcharge or not (non-surcharge taxes apply to the price including surcharges).
false
Amount of the tax
{
"amount": "2160",
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Percentage of the tax
20
{
"type": "VAT",
"surcharge": false,
"taxAmount": {
"amount": 360,
"scale": 2,
"currency": "EUR"
},
"percentage": 20
}
This is the line item price that the customer will pay to the OPCO, including taxes, after applying promotion. Equals (netPrice * quantity + taxes) for items without promotion or (promotionalNetPrice * quantity + taxes) for items with promotion
{
"amount": 2160,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
{
"id": "47138067260809216",
"productId": "3675925",
"itemType": "PRODUCT",
"source": "SPARK",
"quantity": 2,
"prices": {
"netPrice": {
"amount": 1000,
"scale": 2,
"currency": "EUR"
},
"promotionalNetPercentage": 10,
"promotionalNetPrice": {
"amount": 900,
"scale": 2,
"currency": "EUR"
},
"promotionDetails": {
"campaignId": "7575785",
"title": "10% de réduction jusqu'à épuisement du stock",
"alternateProductId": "9898989"
},
"specialPriceAgreement": {
"id": "47384781",
"title": "SPA 1 cheaper than base and SPA 2"
},
"context": {
"type": "SPECIAL_PRICE_AGREEMENT",
"id": "47384781",
"title": "SPA 1 cheaper than base and SPA 2"
},
"taxes": [
{
"type": "VAT",
"surcharge": false,
"percentage": 20
},
{
"type": "BEBAT",
"surcharge": true,
"taxAmount": {
"amount": 100,
"scale": 2,
"currency": "EUR"
},
"percentage": 10
}
],
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
},
"itemTaxes": [
{
"type": "VAT",
"surcharge": false,
"taxAmount": {
"amount": 400,
"scale": 2,
"currency": "EUR"
},
"percentage": 20
},
{
"type": "BEBAT",
"surcharge": true,
"taxAmount": {
"amount": 200,
"scale": 2,
"currency": "EUR"
},
"percentage": 10
}
],
"itemPriceIncludingTaxes": {
"amount": 2400,
"scale": 2,
"currency": "EUR"
}
}
}
{
"id": "47138067260809230",
"productId": "3675921",
"itemType": "PRODUCT",
"source": "OPCO",
"quantity": 3,
"prices": {
"netPrice": {
"amount": 4000,
"scale": 2,
"currency": "EUR"
},
"taxes": [
{
"type": "VAT",
"surcharge": false,
"percentage": 30
}
],
"itemPrice": {
"amount": 12000,
"scale": 2,
"currency": "EUR"
},
"itemTaxes": [
{
"type": "VAT",
"surcharge": false,
"taxAmount": {
"amount": 3600,
"scale": 2,
"currency": "EUR"
},
"percentage": 30
}
],
"itemPriceIncludingTaxes": {
"amount": 15600,
"scale": 2,
"currency": "EUR"
}
}
}
{
"id": "47138067260809450",
"productId": "3675934",
"itemType": "OFFLINE_PRODUCT",
"source": "OPCO",
"offlineProduct": {
"brandName": "Legrand",
"productTitle": "BATTERY CABINETS"
},
"quantity": 1,
"prices": {
"netPrice": {
"amount": 500,
"scale": 2,
"currency": "EUR"
},
"taxes": [
{
"type": "VAT",
"surcharge": false,
"percentage": 30
}
],
"itemPrice": {
"amount": 500,
"scale": 2,
"currency": "EUR"
},
"itemTaxes": [
{
"type": "VAT",
"surcharge": false,
"taxAmount": {
"amount": 150,
"scale": 2,
"currency": "EUR"
},
"percentage": 30
}
],
"itemPriceIncludingTaxes": {
"amount": 650,
"scale": 2,
"currency": "EUR"
}
}
}
List of coupons applied to the cart.
No Additional ItemsThis object represents a coupon into cart
Unique Id to identify a coupon occurrence in the cart. 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 coupon code
"SONEPAR_BIRTHDAY23"
A description of the coupon
"50€ discount on cart because it is our birthday"
The discount provided by the coupon
{
"amount": 5000,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
A flag showing whether or not the presence of other coupons is tolerated
true
Information about the coupon
No Additional ItemsThis object represents a business message to show to the end user. A message could contain either a code or a text.
the severity of the message that could be used to decide on message formatting
"INFO"
A 'blocker' message prevents the redirection to the checkout page. This flag is set to 'true' when the message requires customer attention.
true
the code of the message
"ITEM_REMOVED"
the text of the message
"we would aim to provide all products to you by tomorrow"
{
"severity": "WARN",
"isBlocker": false,
"text": "15€ stil remaining before applying coupon"
}
{
"severity": "WARN",
"isBlocker": false,
"text": "The coupon will expire soon"
}
{
"id": "47138067260809216",
"code": "WINTER_2022",
"description": "Winter is coming! 50€ special discount!",
"discount": {
"amount": 5000,
"scale": 2,
"currency": "EUR"
},
"exclusive": true,
"relatedLineItemsIds": [],
"messages": [
{
"type": "COUPON",
"severity": "WARN",
"text": "This coupon cannot be combined with other"
}
]
}
The list of cart contributors
No Additional ItemsId of the user. 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
"14569778234085376"
The contributor's email
"john.doe@sonepar.com"
The contributor's full name
"John Doe"
A flag to define whether the contributor is the creator of the cart or not
true
A flag to define whether the contributor is a validator of the cart or not
false
A flag to define whether the contributor is using an onbehalf session on or not
false
{
"userId": "14569778234085376",
"email": "john.doe@sonepar.com",
"fullName": "John Doe",
"creator": true,
"validator": false,
"onBehalf": false
}
List of errors returned by cart synchronization api during BASIC or RICH sync, having items within this list must blocks placing an order for the current cart
No Additional ItemsError code
"INPUT_ERROR"
The error message
"Postal number non-existent or municipality incorrect"
{
"code": "INPUT_ERROR",
"message": "Postal number non-existent or municipality incorrect"
}
The total price of all the items added to the cart after applying promotions and coupons, without taxes. This field is included in the response only if the cart contains items.
{
"amount": 13800,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all the items added to the cart before applying promotions and coupons, without taxes. This field is included in the response only if the cart contains items.
{
"amount": 1400,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total discount (Promotions + Coupons) applied to the cart. This field is included in the response only if the cart contains items.
{
"amount": 7000,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The surchage taxes of items added to the cart. This field is included in the response only if the cart contains items.
{
"amount": 200,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all items added to the cart after applying promotions and coupons, including surcharges. This field is included in the response only if the cart contains items.
{
"amount": 14000,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all items added to the cart after applying promotions and coupons, including taxes except the VAT tax, and shipping cost relative to the logistic choices. This field is included in the response only if the cart contains items.
{
"amount": 14015,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total of shipping cost relative to the selected option and scenario. This field is calculated by summing the cost related to the option to the cost related to the scenario. This field is included in the response only if the cart contains items.
{
"amount": 15,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all items added to the cart after applying promotions and coupons, including all taxes. This field is included in the response only if the cart contains items.
{
"amount": 18000,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all items added to the cart after applying promotions and coupons, including shipping cost, surcharges, and taxes. This field is included in the response only if the cart contains items.
{
"amount": 18015,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Total amount of vat applied to items aggregated and sorted in ascending order by vat percentage. This field is included in the response only if the cart contains items and VAT taxes are applied to one or more items.
No Additional ItemsContains information about a tax. May contain a percentage or a taxAmount or both.
The type of the tax.
"VAT"
Is the tax applied as a surcharge or not (non-surcharge taxes apply to the price including surcharges).
false
Amount of the tax
{
"amount": "2160",
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Percentage of the tax
20
{
"type": "VAT",
"surcharge": false,
"taxAmount": {
"amount": 360,
"scale": 2,
"currency": "EUR"
},
"percentage": 20
}
{
"type": "VAT",
"surcharge": false,
"taxAmount": {
"amount": 3600,
"scale": 2,
"currency": "EUR"
},
"percentage": 30
}
Give the detail of all discounts applied to the cart
No Additional Itemscode identifying the discount. Equivalent to 'productId' when the discount is given by a COUPON and 'title' when it is given by PROMOTION
"WINTER_2022"
Indicating the type of the discount
"COUPON"
amount of the discount, in absolute value
{
"amount": 25000,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
{
"code": "WINTER_2022",
"type": "COUPON",
"discount": {
"amount": 5000,
"scale": 2,
"currency": "EUR"
}
}
An array of message to display to the end user related to the cart
No Additional ItemsThis object represents a business message to show to the end user. A message could contain either a code or a text.
the severity of the message that could be used to decide on message formatting
"INFO"
A 'blocker' message prevents the redirection to the checkout page. This flag is set to 'true' when the message requires customer attention.
true
the code of the message
"ITEM_REMOVED"
the text of the message
"we would aim to provide all products to you by tomorrow"
An array of persistent messages to display to the end user related to the cart
No Additional ItemsThis object contains all mandatory information to show to the end user persistent message. A persistent message is showed to the user until this last acknowledges it
Identifier used to access to the persistent message
"123456789"
The operation performed which has raised the message
"BULK_ADD_ITEMS"
The error code
"ITEMS_NOT_ADDED"
The reason that has made the error happened
"PRODUCT_NOT_FOUND"
A short text dealing additional information about the message
"related products : [4789651], [9820367], [39852330]"
An array of bills
No Additional ItemsDetails of a bill that would either represent an invoice or a credit note
The opco identifier of the credit note or the invoice.
"4999569661752721026"
Type of the document, invoice or credit notes
The creation date and time of this credit notes.
"2021-10-12T08:30:22.804Z"
"2021-10-12T08:30:22.804+01:00"
The total amount that should be credited to the customer
{
"amount": 2000000,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Details of an invoice. This document describe invoice meta informations, Invoice complete informations can be downloaded by the customer throught the get document endpoint of the order history api
The status of the bill document. These statuses will not be validated within Spark but will be displayed to the user as CMS label mapped to the status.
"PENDING"
The due date and time where the total amount the should be payed by the customer
"2021-10-12T08:30:22.804Z"
"2021-10-12T08:30:22.804+01:00"
The list of order ids concerned by this invoice
Must contain a minimum of 1 items
[
"order1"
]
[
"order1",
"order2"
]
Details of a credit note; It's sort of a negative bill. It is an amount credited generally during a product return, but also to correct a price or invoicing error. It affects the value of customer invoices and credit line limit.
The status of the bill document. These statuses will not be validated within Spark but will be displayed to the user as CMS label mapped to the status.
"PARTIALLY_USED"
An optional list of order ids concerned by this credit note.
Must contain a minimum of 1 items
[
"order1"
]
[
"order1",
"order2"
]
An optional list of invoice numbers concerned by this credit note.
Must contain a minimum of 1 items
[
"4999569661752721026"
]
[
"4999569661752721027",
"4999569661752721028"
]
The amount due in case the bill is partially processed.
{
"amount": 500000,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
An array of products
{
"productsNotFound": [
"456789765999",
"987678987877"
],
"gtinsNotFound": [
"0000228",
"0000229"
],
"products": [
{
"productId": "9554961192345",
"opcoId": "NOR-OTRA",
"identifier": {
"gtin": "0000228",
"productTitle": "LIGHT 274498 Metal Halide Lamp",
"opcoProductId": "274498",
"manufacturerRefId": "1360168",
"manufacturerName": "PHILIPS ELECTRONICS",
"manufacturerRef": "Metal Lamp",
"customerReference": "9554961192345C",
"brandName": "SASS",
"tags": [
"NEW"
],
"stockIndicator": "L",
"keywords": [
"Halide Lamp"
]
},
"orderingDetail": {
"orderUnit": "CR62",
"contentUnit": "MLT",
"packingQuantity": 200,
"minQuantity": 6,
"isSoldLoose": true,
"quantitySteps": 6
},
"description": {
"additionalInfo": [
"The product shall be shipped with extra care (e.g horizontal aligned)"
],
"longDescription": "High performance, Long life and Superior light quality A compact, energy efficient metal halide lamp that provides crisp, sparkling light with long life and high efficiency.",
"specialInstructions": [
"MSDS or ECCN info 1",
"MSDS or ECCN info 2"
],
"legalDisclaimer": [
"WARNING: Certain home improvement projects are inherently dangerous, and even the most benign tool can cause serious injury or death if not used properly"
],
"erpShortDescription": "pressure clamp nylon"
},
"categorisation": [
"S01"
],
"features": [
{
"name": "EF000007",
"value": "EF000080",
"unit": "",
"detail": "azure blue",
"rank": 1
},
{
"name": "EF000007",
"value": "EF000080",
"unit": "",
"detail": "azure blue",
"rank": 2
}
],
"references": [
{
"type": "accessory",
"productIdTo": "6787867575768"
},
{
"type": "similar",
"productIdTo": "6787867575999"
}
],
"packingInfo": [
{
"code": "consumer",
"count": 6,
"minQuantity": 2,
"maxQuantity": 12,
"isPackageBreak": true,
"length": 2.4,
"width": 1.2,
"depth": 3.5,
"weight": 2.2,
"diameter": 5.2,
"volume": 1.2,
"packingGtin": "7756465775751",
"dimensionUnit": "mm",
"weightUnit": "kg",
"volumeUnit": "mm^3"
}
],
"warranty": 1,
"series": "JUSSI",
"expectedDeliveryTime": 2,
"isEcommerceReady": true,
"lifecycle": {
"expirationDate": "2023-01-25T10:22:00.116697Z",
"manufactureDate": "2017-01-25T10:22:00.116697Z"
},
"greenOffer": {
"carbonFootprint": {
"value": 34.93,
"unit": "KGM"
},
"greenRating": "A"
}
},
{
"productId": "9554961192233",
"opcoId": "BEL-CEBEO",
"identifier": {
"gtin": "0000229",
"opcoProductId": "274638",
"productTitle": "Switch 274638 Plastic",
"manufacturerRefId": "1360167",
"manufacturerName": "LEGRAND",
"manufacturerRef": "plastic switch",
"customerReference": "9554961192233C",
"brandName": "SASS",
"tags": [
"NEW"
],
"stockIndicator": "C",
"keywords": [
"interrupteur",
"Plastique"
]
},
"orderingDetail": {
"orderUnit": "PA",
"contentUnit": "C62",
"packingQuantity": 12,
"minQuantity": 6,
"isSoldLoose": true,
"quantitySteps": 6
},
"description": {
"additionalInfo": [
"The product shall be shipped with extra care (e.g horizontal aligned)"
],
"longDescription": "High performance switch, Long life and Superior quality A compact, energy efficient that provides stability",
"specialInstructions": [
"MSDS or ECCN info",
"MSDS or ECCN info"
],
"legalDisclaimer": [
"WARNING: Certain home improvement projects are inherently dangerous, and even the most benign tool can cause serious injury or death if not used properly"
],
"erpShortDescription": "iC60a 3P 25A C"
},
"categorisation": [
"S01"
],
"features": [
{
"name": "EF000007",
"value": "EF000080",
"unit": "",
"detail": "azure blue",
"rank": 1
},
{
"name": "EF000008",
"value": "EF000081",
"unit": "",
"detail": "azure green",
"rank": 2
}
],
"references": [
{
"type": "spare part",
"productIdTo": "2763757293902"
},
{
"type": "accessories",
"productIdTo": "2763757293978"
}
],
"packingInfo": [
{
"code": "consumer",
"count": 6,
"minQuantity": 2,
"maxQuantity": 12,
"isPackageBreak": true,
"length": 2.4,
"width": 1.2,
"depth": 3.5,
"weight": 2.2,
"diameter": 5.2,
"volume": 1.2,
"packingGtin": "7537686286863",
"dimensionUnit": "mm",
"weightUnit": "kg",
"volumeUnit": "mm^3"
}
],
"warranty": 1,
"series": "JUSSI",
"expectedDeliveryTime": 2,
"isEcommerceReady": true,
"lifecycle": {
"expirationDate": "2023-01-25T10:22:00.116697Z",
"manufactureDate": "2017-01-25T10:22:00.116697Z"
},
"greenOffer": {
"carbonFootprint": {
"value": 34.93,
"unit": "KGM"
},
"greenRating": "A"
}
}
]
}
An array of not found products
No Additional ItemsAn array of not found products
No Additional ItemsAn array of products
No Additional Itemsa product object description
unique Spark product identifier.
"9554961192345"
Deprecated - The caller knows its opcoId, this field is useless.
Sub-Identifier for particular Opco
"BEL-CEBEO"
product identifier attributes
{
"gtin": "0000228",
"opcoProductId": "65",
"productTitle": "Switch 274638 Plastic",
"manufacturerRefId": "1360167",
"manufacturerName": "LEGRAND",
"manufacturerRef": "2742037 12-20 LGR638",
"customerReference": "9554961192345C",
"brandName": "SASS",
"tags": [
"NEW",
"PROMO"
],
"stockIndicator": "B",
"keywords": [
"Plastique"
]
}
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
"$1"
Deprecated - Manufacturer fields are used instead.
This is the supplier ID
"1234456"
This is the manufacturer reference id and is always used for search and identifying the product
"1360167"
This is the custom reference used by a customer to identify the product in their system. Not defined in case of anonymous navigation or if the customer didn't set one for this product.
"$1"
short description of the product
"LIGHT 274498 Metal Halide Lamp"
manufacturer name and brand name are the same
"PHILIPS ELECTRONICS"
Construction type, number of cores and nominal cross section from manufacturer
"2037 12-20 LGR"
Brand name
"$1"
Deprecated - Assets are used directly.
This is the primary image url to the product
"https://pl.eaton.com/image?doc_name=40071354241&type=preview"
Use ABCL code A= branch (+CDC) B= CDC C= OnDemand L = end of life (product is sold until our stock runs out, no backorders allowed, no longer available from the supplier)
"$1"
array of keywords used for seo and search readiness
No Additional Itemsordering detail comprising packing and quantity details
{
"orderUnit": "CR62",
"contentUnit": "MLT",
"packingQuantity": 200,
"minQuantity": 6,
"isSoldLoose": true,
"quantitySteps": 6
}
order unit are the units in which a product is being sold, e.g TN - tin
"$1"
content unit is the exact measurable unit e.g MLT - milliliter
"$1"
It is number of content unit per order unit e.g 200 (Spray tin 200 ML)
200
minimum quantity which could be ordered
6
Is it sold in loose apart from packing
true
sold in steps or quantity intervals
6
Deprecated - Assets are used directly.
This contains all the alternative images of the product
"https://pl.eaton.com/image?doc_name=40071354241&type=preview"
"https://pl.eaton.com/image?doc_name=40071354242&type=preview"
An array containing all the asset items related to the product
No Additional ItemsAn asset detail.
{
"type": "DOCUMENT",
"sourceUrl": "https://eshop.schneider-electric.com/product.aspx?productid=ZC2JY41&dist=616&org=30&lang=1",
"externalUrl": "https://neweshop-preprod.cebeo.be/caas/v1/media/13258630/data/2921f90a2a830b702626dc421e6ee71a",
"title": "61212886_technical_data_sheet_ZC2JY41.pdf",
"order": 22
}
Asset type.
Order in which the image should be displayed.
1
Deprecated - The field is not used anymore.
Original OpCo url from which the asset is accessible.
"https://pl.eaton.com/image?doc_name=40071354241&type=preview"
url from which the asset is accessible from the digital asset management (DAM) solution.
"https://neweshop-preprod.cebeo.be/caas/v1/media/39855944/data/7770df2e814920da1287ab5a9301a27d"
Asset's title.
"Fluke_brand_icon"
Asset category.
This object contains all available information of the product
{
"additionalInfo": [
"The product shall be shipped with extra care (e.g horizontal aligned)"
],
"longDescription": "High performance, Long life and Superior light quality A compact, energy efficient metal halide lamp that provides crisp, sparkling light with long life and high efficiency.",
"specialInstructions": [
"MSDS or ECCN info",
"MSDS or ECCN info"
],
"legalDisclaimer": [
"WARNING: Certain home improvement projects are inherently dangerous, and even the most benign tool can cause serious injury or death if not used properly"
],
"erpShortDescription": "pressure clamp nylon"
}
contains any additional remarks or info for the product
No Additional Items"The product shall be shipped with extra care (e.g horizontal aligned)"
contains detailed 1-2 lines of description for the product
"High performance, Long life and Superior light quality A compact, energy efficient metal halide lamp that provides crisp, sparkling light with long life and high efficiency."
contains any special instructions based on special treatment class such as hazardous goods
No Additional Items"MSDS or ECCN info"
"MSDS or ECCN info"
contains the list of legal disclaimers associated with a product
No Additional Items"WARNING: Certain home improvement projects are inherently dangerous, and even the most benign tool can cause serious injury or death if not used properly"
A very short ERP description to be shown on PDP and also used while generating invoices
"pressure clamp nylon"
contains the list of category Ids that the product belongs to
No Additional Items"S01C0100580"
"S01C0100660"
features based generic classification standards defined as catalog -> categories/sub-Categories -> sub-categories -> products -> features
No Additional Itemsfeatures of the product belonging to a catalog under a category
name of the feature based on etim code
"$1"
value of the feature, some cases it could be multiple value e.g (50 mm-50 mm)
"20"
the unit of the technical characteristic
"$1"
specific description of value details of the feature if any
"azure blue"
This is the order of the features. Top 5 ranks to be shown as essential or most important specification
Value must be greater or equal to 1
1
{
"name": "color",
"value": "blue",
"unit": "",
"detail": "azure blue",
"rank": 1
}
{
"name": "voltage",
"value": "220",
"unit": "watts",
"detail": "",
"rank": 2
}
Deprecated - Assets are used directly.
contains all the mime info for the product except images such as data sheets, videos, weblinks
array of available assets except images like pdf documents, web links, videos etc
the type of mime , whether it is pdf, web link, safety data sheet etc
"$1"
this is the source of the mime, generally a url to the resource
"https://pl.eaton.com/image?doc_name=40071354241&type=preview"
{
"type": "pdf",
"source": "http://www.ceag.de/sites/ceag.de/files/products/datasheets/cooper-ceag-datasheet-71011-71021-led-zweiseitig-32-m_8.pdf?locale=en"
}
{
"type": "weblink",
"source": "https://pl.eaton.com/image?doc_name=40071354241&type=preview"
}
references to similar products, accessories, spare parts, mandatory essentials, component parts etc
No Additional Itemsreferences to the current product e.g accessories, spare parts etc
the reference type of the product such as accessory, mandatory essential
"$1"
the reference product id to which this product belongs
"6787867575768"
{
"type": "accessories",
"productIdTo": "6787867575768"
}
{
"type": "similar",
"productIdTo": "6787867575879"
}
list of detailed information for packing of the product
No Additional Itemsdetailed information for packing of the product
packing code of the product such as distributor or consumer
"$1"
no of products being packaged in a packing
6
min quantity which is compliant to packing units (crate or box)
2
max quantity which is compliant to packing units (crate or box)
12
This determines if the packing is mandatory or not based on min-max quantity
true
length of packing object
2.4
width of packing object
1.2
depth of packing object
3.5
weight of packing object
2.2
diameter of packing object
5.2
volume of packing object
1.2
unique code of the packing
"7756465775751"
the dimension unit of measure
"$1"
the weight unit of measure
"$1"
the volume unit of measure
"mm^3"
{
"code": "consumer",
"count": 6,
"minQuantity": 2,
"maxQuantity": 12,
"isPackageBreak": true,
"length": 2.4,
"width": 1.2,
"depth": 3.5,
"weight": 2.2,
"diameter": 5.2,
"volume": 1.2,
"packingGtin": "7756465775751",
"dimensionUnit": "mm",
"weightUnit": "kg",
"volumeUnit": "mm^3"
}
Deprecated - Use warranty instead.
guarantee of a product varying with different opcos
1
warranty of a product varying with different opcos
1
The series to which the product belongs to depending on opco
"$1"
Deprecated - Use expectedDeliveryTime instead.
the average time of delivery from the date of order, in days
Value must be greater or equal to 0
2
the average time of delivery from the date of order, in days
Value must be greater or equal to 0
2
Is the current product e-commerce ready. To be used for analytics to prioritise enriching the product data based on its demand and make it ready for e-commerce
false
product validity range when it became active and when it expires
{
"expirationDate": "2023-01-25T10:22:00.116697Z",
"manufactureDate": "2017-01-25T10:22:00.116697Z"
}
date until when the product is active or when it is due to expire, in ISO 8601 standard
"2023-01-25T10:22:00.116697Z"
date when the product is manufactured and becomes active, in ISO 8601 standard
"2017-01-25T10:22:00.116697Z"
This determines if the product is considered as returnable or not.
true
green offer information
{
"carbonFootprint": {
"value": 34.93,
"unit": "KGM"
},
"greenRating": "A"
}
This determines the carbon footprint of the product.
This determines the co2 footprint value.
34.93
This determines the product's co2 footprint unit of measure. Values are gs1 codes of mass units of Kilogram and Gram.
"$1"
This determines the SONEPAR's green rating of the product. Values are A, B and C with A representing the best rating.
"$1"
Model used to represent a user.
unique identifier of the user
Must match regular expression:^[0-9]+$
"234564567898789"
User's honorific title.
"Mr"
email address of the user. Will be use to authenticate the user
"john.doe@ge.com"
User's first name.
"John"
User's last name.
"Doe"
User's phone number.
"+3265150833"
User's fixed phone number.
"+3265150833"
Set of accounts attached to the user.
No Additional ItemsModel used to create user permissions
technical unique id of the attached account
Must match regular expression:^[0-9]+$
"234564567898789"
OpCo internal system's unique identifier for the account.
Must match regular expression:^(?=\s*\S).*$
"776544"
user's job denomination code. This is the reference code for the value provided in jobTitle field
"M01"
User's job denomination.
"Manager"
User status in the erp
"ACTIVE"
Determines whether or not the user is allowing associates to impersonate him in order to perform some actions in the web shop (placing an order, creating a quote...)
false
Set of permissions
No Additional ItemsEnumeration of permission available in the Spark platform.
"VIEW_NET_PRICE"
"MANAGE_USERS"
"CONTRIBUTE_CART"
The price preference of the user
"ONLY_GROSS_PRICE"
user preference for a specific account.
{
"spa": "ALL"
}
User's SPA preferences.
"NONE"
Max amount of a cart that the user can order without validation. This configuration is only applicable when the permission PLACEORDERWITHOUT_VALIDATION is activated.
{
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Max amount that the user can order without validation during a month. This configuration is only applicable when the permission PLACEORDERWITHOUT_VALIDATION is activated.
{
"amount": 3000,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The remaining amount that the user can order without validation. The field is calculated by deducting the amount the user orders from the monthly purchase limit. The remaining monthly purchase balance Is reset at the beginning of each month.
{
"amount": 500,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
{
"accountId": "345678",
"id": "3456789",
"opCoUserStatus": "ACTIVE",
"jobCode": "M01",
"jobTitle": "Manager",
"permissions": [
"MANAGE_USERS",
"EXPORT_INVOICE"
],
"cartLimit": {
"amount": 1000,
"scale": 2,
"currency": "EUR"
},
"monthlyPurchaseLimit": {
"amount": 10000,
"scale": 2,
"currency": "EUR"
},
"remainingMonthlyPurchaseBalance": {
"amount": 5000,
"scale": 2,
"currency": "EUR"
}
}
Number of attached accounts to the user
2
PENDING is the default status when a new object is created.
Locale intended to identify user's preferred language for a given country.
"fr-BE"
An array of messages
No Additional ItemsThis object represents a business message to show to the end user. A message could contain either a code or a text.
the severity of the message that could be used to decide on message formatting
"INFO"
A 'blocker' message prevents the redirection to the checkout page. This flag is set to 'true' when the message requires customer attention.
true
the code of the message
"ITEM_REMOVED"
the text of the message
"we would aim to provide all products to you by tomorrow"
An array of orders
No Additional ItemsAn order as created by spark
The order id generated by the spark plateform.
"4999569661752721026"
The order id known by the opco and the customer. Two orders can't have the same Id
"4999569661752721026"
"49995696_ORG1"
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"
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"
Model used to describe addresses
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
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"
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"
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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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 information about a tax. May contain a percentage or a taxAmount or both.
The type of the tax.
"VAT"
Is the tax applied as a surcharge or not (non-surcharge taxes apply to the price including surcharges).
false
Amount of the tax
{
"amount": "2160",
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Percentage of the tax
20
[
{
"type": "VAT",
"isSurcharge": false,
"percentage": 20.0
}
]
[
{
"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
}
]
}
}
]
The list of logistic details related to this order
Must contain a minimum of 1 items
Information about the logistic details of the current order (logistic method, logistic preferences, logistic options, delivery address, facility id)
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'.
The address used for delivery when logistic method is 'DELIVERY'
{
"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"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
The logistic option chosen for the selected logistic method (e.g a standard delivery is a logistic option).
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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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.
This status is to be used for tracking and tracing the order.
The OpCos have to send a normalised status as listed in below examples.
These new status codes are applicable for new orders only.
Using legacy status codes (not part of the examples) won't break anything but the track and trace wont reflect order status changes.
The status codes sent are mapped to labels in the CMS.
For orders first validation or acceptance by opco the status would be ACCEPTED.
For orders in preparartion until they are shipped, the status would be IN_PREPARATION.
For all orders shipped and in Transit, the status would be SHIPPED.
For all orders delivered at source the status would be DELIVERED
For cancelled lineItems, the shipping group with a status value CANCELLED is expected.
For back ordered lineItems, the shipping group with a status value BACK_ORDERED is expected.
The OPENED status should only be used in OpCoOrders for Marketplace orders (where opcos delegate order lifecycle management to sellers).
The AVAILABLE_FOR_PICKUP status should be used in PICKUP when the order is ready to be picked up in branch.
The AVAILABLE_IN_LOCKER status should be used in PICKUP when the order is ready to be picked up in locker.
The COLLECTED status should be used in PICKUP when the order hass been collected from branch or locker.
"ACCEPTED"
"IN_PREPARATION"
"SHIPPED"
"DELIVERED"
"CANCELLED"
"BACK_ORDERED"
"OPENED"
"AVAILABLE_FOR_PICKUP"
"AVAILABLE_IN_LOCKER"
"COLLECTED"
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"
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.
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.
{
"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"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"
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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
[
{
"quantity": 1,
"lineItemId": "1",
"itemPrice": {
"amount": 1800,
"scale": 2,
"currency": "EUR"
}
}
]
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"
[
{
"type": "DELIVERY_NOTES",
"id": "4999569661752721026",
"createdAt": "2017-07-21T17:32:28Z"
}
]
[
{
"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"
}
}
]
}
]
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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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"
}
]
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 cart
Unique identifier of the project
"47384783"
The name of the project
"StandElec project"
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
The 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"
}
]
The total amount of all the items of the order after applying promotions and coupons, without taxes.
{
"amount": 13800,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following 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"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total price of all items of the order applying promotions and coupons, including all taxes.
{
"amount": 17760,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
The total amount of each tax.
No Additional ItemsContains information about a tax. May contain a percentage or a taxAmount or both.
The type of the tax.
"VAT"
Is the tax applied as a surcharge or not (non-surcharge taxes apply to the price including surcharges).
false
Amount of the tax
{
"amount": "2160",
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
Percentage of the tax
20
[
{
"type": "VAT",
"isSurcharge": false,
"taxAmount": {
"amount": 12000,
"scale": 4,
"currency": "EUR"
}
},
{
"type": "ECOTAXE",
"isSurcharge": true,
"taxAmount": {
"amount": 260,
"scale": 2,
"currency": "EUR"
}
}
]
List of coupon added to the cart.
Must contain a minimum of 1 items
This object represents a coupon into cart
Unique Id to identify a coupon occurrence in the cart. 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 coupon code
"SONEPAR_BIRTHDAY23"
A description of the coupon
"50€ discount on cart because it is our birthday"
The discount provided by the coupon
{
"amount": 5000,
"scale": 2,
"currency": "EUR"
}
Unscaled price amount
20000
the scale to be applied on the amount
2
the currency code following ISO 4217 standard 3 letter in which the prices are being displayed
"EUR"
A flag showing whether or not the presence of other coupons is tolerated
true
Information about the coupon
No Additional ItemsThis object represents a business message to show to the end user. A message could contain either a code or a text.
the severity of the message that could be used to decide on message formatting
"INFO"
A 'blocker' message prevents the redirection to the checkout page. This flag is set to 'true' when the message requires customer attention.
true
the code of the message
"ITEM_REMOVED"
the text of the message
"we would aim to provide all products to you by tomorrow"
{
"severity": "WARN",
"isBlocker": false,
"text": "15€ stil remaining before applying coupon"
}
{
"severity": "WARN",
"isBlocker": false,
"text": "The coupon will expire soon"
}
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
Identifier
Contains seller information
OpCo SellerId, as provided operator internal id for this seller.
Seller name
An array of facilities
No Additional ItemsObject representing a facility
The id of the facility
"AB2"
The name of the facility
"Antwerp Branch"
The address of the facility
{
"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"
}
Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
"234564567898789"
OpCo internal system's unique identifier for the address.
"237564557868778"
According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
"chaussée Verlinden 22"
According to ISO 19160 the 2/3 component of the street address.
"1st floor"
According to ISO 19160 the 3/3 component of the street address.
"Apparment 2"
The city name
"Bruges"
The region name
"Frandre"
The department name
"N/A"
Country code
"Belgium"
Postal code
"0287"
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
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
"Reference 123"