This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

Punchout Shopping Cart

Type: object

Internal This schema is used internally by Spark, not for OpCo integration.
The punchout shopping cart event is pushed by the punchout MS when transmitting cart to the customer e-procurement system

 No Additional Properties
Example:

{
    "eventHeader": {
        "source": "SPARK",
        "version": "v1"
    },
    "identifier": {
        "cartId": "1234567890"
    },
    "name": "Shopping Cart",
    "accountId": "account123",
    "createdOn": "2023-10-01T12:00:00Z",
    "transmittedOn": "2023-10-01T13:00:00Z",
    "lastModifiedOn": "2023-10-01T14:00:00Z",
    "billingAddress": {
        "addressId": "234564567898789",
        "opCoAddressId": "237564557868778",
        "addressLine1": "chaussée Verlinden 22",
        "addressLine2": "Apartment 2",
        "city": "Bruges",
        "countryCode": "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"
    },
    "logisticDetails": {
        "logisticMethod": "DELIVERY",
        "supportedLogisticMethods": [
            "DELIVERY",
            "PICK_UP"
        ],
        "facilityId": "facility123",
        "facilityName": "Main Facility",
        "deliveryAddress": {
            "addressLine1": "456 Secondary St",
            "city": "Othertown",
            "country": "USA",
            "postalCode": "67890"
        }
    },
    "items": [
        {
            "id": "123",
            "itemType": "PRODUCT",
            "quantity": 2,
            "prices": {
                "netPrice": {
                    "amount": 100,
                    "scale": 2,
                    "currency": "USD"
                },
                "listPrice": {
                    "amount": 200,
                    "scale": 2,
                    "currency": "USD"
                },
                "taxes": [
                    {
                        "type": "VAT",
                        "surcharge": false,
                        "taxAmount": {
                            "amount": 10,
                            "scale": 2,
                            "currency": "USD"
                        },
                        "percentage": 10
                    }
                ],
                "itemPrice": {
                    "amount": 110,
                    "scale": 2,
                    "currency": "USD"
                },
                "itemTaxes": [
                    {
                        "type": "VAT",
                        "surcharge": false,
                        "amount": 10,
                        "scale": 2,
                        "currency": "USD"
                    }
                ],
                "itemPriceIncludingTaxes": {
                    "amount": 120,
                    "scale": 2,
                    "currency": "USD"
                }
            }
        }
    ],
    "coupons": [
        {
            "id": "736923",
            "code": "DISCOUNT10",
            "description": "10% off",
            "discount": {
                "amount": 10,
                "scale": 2,
                "currency": "USD"
            },
            "exclusive": true
        }
    ],
    "contributors": [
        {
            "email": "contributor@example.com",
            "fullName": "John Doe",
            "creator": true,
            "validator": false,
            "onbehalf": false
        }
    ],
    "messages": [
        {
            "severity": "INFO",
            "isBlocker": true,
            "code": "ITEM_REMOVED"
        }
    ],
    "persistentMessages": [
        {
            "id": "123456789",
            "operation": "BULK_ADD_ITEMS",
            "code": "ITEMS_NOT_ADDED",
            "reasonCode": "PRODUCT_NOT_FOUND",
            "additionalInfo": "related products : [4789651], [9820367], [39852330]"
        }
    ],
    "opcoId": "opco123",
    "orgId": "org123",
    "richSynchronizedOn": "2023-10-01T15:00:00Z",
    "opcoCartId": "opcoCart123",
    "includeAllSpas": false,
    "specialPriceAgreements": [
        {
            "id": "spa123",
            "title": "Special Price Agreement"
        }
    ],
    "project": {
        "id": "project123",
        "name": "Project Name"
    },
    "quote": {
        "id": "quote123",
        "name": "Quote Name",
        "code": "Q123",
        "version": "v1"
    },
    "totalPrice": {
        "amount": 220,
        "scale": 2,
        "currency": "USD"
    },
    "totalPriceExcludingPromotions": {
        "amount": 240,
        "scale": 2,
        "currency": "USD"
    },
    "totalPromotions": {
        "amount": 20,
        "scale": 2,
        "currency": "USD"
    },
    "totalSurchargeTaxes": {
        "amount": 5,
        "scale": 2,
        "currency": "USD"
    },
    "totalPriceIncludingSurcharges": {
        "amount": 225,
        "scale": 2,
        "currency": "USD"
    },
    "totalPriceIncludingSurchargesAndShipping": {
        "amount": 230,
        "scale": 2,
        "currency": "USD"
    },
    "totalShippingCosts": {
        "amount": 10,
        "scale": 2,
        "currency": "USD"
    },
    "totalPriceIncludingTaxes": {
        "amount": 250,
        "scale": 2,
        "currency": "USD"
    },
    "totalPriceAllIncluded": {
        "amount": 260,
        "scale": 2,
        "currency": "USD"
    },
    "totalVatByPercentage": [
        {
            "type": "VAT",
            "surcharge": false,
            "percentage": 10,
            "amount": 25,
            "scale": 2,
            "currency": "USD"
        }
    ],
    "discountDetails": [
        {
            "code": "DISCOUNT10",
            "type": "COUPON",
            "discount": {
                "amount": 10,
                "scale": 2,
                "currency": "USD"
            }
        }
    ]
}

root eventHeader
Type: object

Contains information about the event, including the source, version, and scopes.

root eventHeader source
Type: enum (of string)

Represents the origin of the event.

Must be one of:

  • "SPARK"

root eventHeader version
Type: enum (of string)

Represents the version of the event schema. It's used to handle changes and evolution of the event structure over time.

Must be one of:

  • "v1"

root identifier
Type: object

Contains the unique identifier for the logistic order.

root identifier cartId
Type: string

Cart 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]+$
Example:

"17050283147243520"

root opcoId
Type: string

Unique identifier for OpCo.
Example:

"USA-SPRFLD"

root name
Type: string

Cart name. If the name is not filled in, its value will be set to "Shopping Cart".
Example:

"Shopping Cart."

root accountId
Type: string

OpCo account's identifier from which the cart is created.

Must match regular expression: ^(?=\s*\S).*$
Example:

"4999569661752721026"

root orgId
Type: string

Commerce organization identifier. Only present if the account includes one.

Must match regular expression: ^(?=\s*\S).*$
Example:

"org1"

root createdOn
Type: stringFormat: date-time

Creation date time of the cart
Example:

"2020-10-12T08:30:22.8045280+00:00"

root transmittedOn
Type: stringFormat: date-time

transmission date of the cart to the external system
Example:

"2020-10-12T08:30:22.8045280+00:00"

root lastModifiedOn
Type: stringFormat: date-time

last modification date time of the cart
Example:

"2020-10-12T14:30:45.1076240+00:00"

root richSynchronizedOn
Type: stringFormat: date-time

Last date-time of cart rich synchronization with Opco ERP
Example:

"2020-10-12T14:30:50.1076240+00:00"

root billingAddress

Address

Type: object

Address to which the billing informations would be sent
Example:

{
    "addressLine1": "chaussée Verlinden 22",
    "addressLine2": "Apartment 2",
    "city": "Bruges",
    "country": "BEL",
    "postalCode": "0287"
}

root billingAddress addressId
Type: string

Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
Example:

"234564567898789"

root billingAddress opCoAddressId
Type: string

OpCo internal system's unique identifier for the address.
Example:

"237564557868778"

root billingAddress addressLine1
Type: string

According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
Example:

"chaussée Verlinden 22"

root billingAddress addressLine2
Type: string

According to ISO 19160 the 2/3 component of the street address.
Example:

"1st floor"

root billingAddress addressLine3
Type: string

According to ISO 19160 the 3/3 component of the street address.
Example:

"Apparment 2"

root billingAddress city
Type: string

The city name
Example:

"Bruges"

root billingAddress region
Type: string

The region name
Example:

"Frandre"

root billingAddress department
Type: string

The department name
Example:

"NA"

root billingAddress countryCode
Type: string

Country code

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"Belgium"

root billingAddress postalCode
Type: string

Postal code
Example:

"0287"

root billingAddress addressName
Type: string

Extra description about the address
Example:

"Building site 1"

root billingAddress companyName
Type: string

Company name, it might differ from the account name
Example:

"Easy Electric"

root billingAddress contactFirstName
Type: string

Address contact's first name
Example:

"John"

root billingAddress contactLastName
Type: string

Address contact's last name
Example:

"Doe"

root billingAddress contactPhoneNumber
Type: string

Address contact's Phone number. The phone number is E164 format

Must match regular expression: ^\+[1-9]\d{1,14}$
Example:

"+330287345678"

root billingAddress deliveryIndication
Type: string

Optional indications or instructions about the delivery
Example:

"Please leave the parcel next the front door"

root billingAddress customerReference
Type: string

Optional reference about the customer
Example:

"Reference 123"

root logisticDetails

LogisticDetails

Type: object

Information about the logistic details of the current cart (logistic method, logistic preferences, logistic options, delivery address, facility id)

root logisticDetails logisticMethod
Type: enum (of string)

Logistic method chosen for the cart

Must be one of:

  • "DELIVERY"
  • "PICK_UP"

Example:

"PICK_UP"

root logisticDetails supportedLogisticMethods
Type: array of enum (of string)

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

No Additional Items

Each item of this array must be:

root logisticDetails supportedLogisticMethods supportedLogisticMethods items
Type: enum (of string)

Must be one of:

  • "DELIVERY"
  • "PICK_UP"

Examples:

"DELIVERY"

"PICK_UP"

root logisticDetails cdcFacilityId
Type: string

Unique identifier of the consolidated distribution center facility from which the order will be delivered
Example:

"cdc_erp_id_1"

root logisticDetails facilityId
Type: string

Unique identifier of the facility.
Example:

"395"

root logisticDetails facilityName
Type: string

Name of the facility used.
Example:

"SONEPAR Facility"

root logisticDetails deliveryAddress

Address

Type: object

The address used for delivery when logistic method is 'DELIVERY'
Example:

{
    "addressId": "234564567898789",
    "opCoAddressId": "237564557868778",
    "addressLine1": "chauss�e 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"
}

root logisticDetails deliveryAddress addressId
Type: string

Address unique identifier on spark. Its value must contain a 64-bit long number represented as a string.
Example:

"234564567898789"

root logisticDetails deliveryAddress opCoAddressId
Type: string

OpCo internal system's unique identifier for the address.
Example:

"237564557868778"

root logisticDetails deliveryAddress addressLine1
Type: string

According to ISO 19160 the 1/3 component of the street address. This usually contains the whole address though
Example:

"chaussée Verlinden 22"

root logisticDetails deliveryAddress addressLine2
Type: string

According to ISO 19160 the 2/3 component of the street address.
Example:

"1st floor"

root logisticDetails deliveryAddress addressLine3
Type: string

According to ISO 19160 the 3/3 component of the street address.
Example:

"Apparment 2"

root logisticDetails deliveryAddress city
Type: string

The city name
Example:

"Bruges"

root logisticDetails deliveryAddress region
Type: string

The region name
Example:

"Frandre"

root logisticDetails deliveryAddress department
Type: string

The department name
Example:

"NA"

root logisticDetails deliveryAddress countryCode
Type: string

Country code

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"Belgium"

root logisticDetails deliveryAddress postalCode
Type: string

Postal code
Example:

"0287"

root logisticDetails deliveryAddress addressName
Type: string

Extra description about the address
Example:

"Building site 1"

root logisticDetails deliveryAddress companyName
Type: string

Company name, it might differ from the account name
Example:

"Easy Electric"

root logisticDetails deliveryAddress contactFirstName
Type: string

Address contact's first name
Example:

"John"

root logisticDetails deliveryAddress contactLastName
Type: string

Address contact's last name
Example:

"Doe"

root logisticDetails deliveryAddress contactPhoneNumber
Type: string

Address contact's Phone number. The phone number is E164 format

Must match regular expression: ^\+[1-9]\d{1,14}$
Example:

"+330287345678"

root logisticDetails deliveryAddress deliveryIndication
Type: string

Optional indications or instructions about the delivery
Example:

"Please leave the parcel next the front door"

root logisticDetails deliveryAddress customerReference
Type: string

Optional reference about the customer
Example:

"Reference 123"

root opcoCartId
Type: string

The cart or the open order identifier at opco system level
Example:

"cart-1615220019126"

root includeAllSpas
Type: boolean Default: false

If its value set to true, then all special price agreements (SPAs) should be included in the price calculation.
If its value set to false, then all SPAs should be excluded in the price calculation.
The presence of specialPriceAgreements array will override this parameter and this parameter should be ignored.
Example:

false

root specialPriceAgreements
Type: array

Special price agreements

 No Additional Items

Each item of this array must be:

root specialPriceAgreements SpecialPriceAgreement

SpecialPriceAgreement

Type: object

Special price agreement

root specialPriceAgreements SpecialPriceAgreement id
Type: string

Identifier of the special price agreement
Example:

"47384781"

root specialPriceAgreements SpecialPriceAgreement title
Type: string

Title of the special price agreement
Example:

"SPA 1 cheaper than base and SPA 2"

Examples:

{
    "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"
}

root project

Project

Type: object

The project associated to the cart

root project id
Type: string

Unique identifier of the project
Example:

"47384783"

root project name
Type: string

The name of the project
Example:

"StandElec project"

root quote

Quote

Type: object

The quote associated to the cart

root quote id
Type: string

Unique identifier of the quote
Example:

"quote-001"

root quote name
Type: string

The name of the quote
Example:

"Quote 001"

root quote code
Type: string

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
Example:

"49995666"

root quote version
Type: string

The version of this quote. Used by some opco system to select the right version of the quote.
Example:

"1"

root items
Type: array

list of items added to the cart. Last added item is in the top

 No Additional Items

Each item of this array must be:

root items Item

Item

Type: object

This object represent a product item into cart

root items Item id
Type: string

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]+$
Example:

"2196602318024039368"

root items Item prices

Prices

Type: object

Contains the detail of prices related to the current product and line item

root items Item prices netPrice

Price

Type: object

This is the product unit price that the customer will pay to the OPCO, without taxes, before applying promotion.
Example:

{
    "amount": 1000,
    "scale": 2,
    "currency": "EUR"
}

root items Item prices netPrice amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root items Item prices netPrice scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root items Item prices netPrice currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root items Item prices listPrice

Price

Type: object

List price of the product, to be used/shown in case there is no customer negotiated net price
Example:

{
    "amount": 1000,
    "scale": 2,
    "currency": "EUR"
}

root items Item prices listPrice amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root items Item prices listPrice scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root items Item prices listPrice currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root items Item prices promotionalNetPercentage
Type: number

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.
Example:

10

root items Item prices promotionalNetPrice

Price

Type: object

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
Example:

{
    "amount": 900,
    "scale": 2,
    "currency": "EUR"
}

root items Item prices promotionalNetPrice amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root items Item prices promotionalNetPrice scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root items Item prices promotionalNetPrice currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root items Item prices promotionDetails

PromotionDetails

Type: object

Details of the promotion applied to this item
Example:

{
    "campaignId": "7575785",
    "title": "10% de r�duction jusqu'� �puisement du stock",
    "alternateProductId": "9898989"
}

root items Item prices promotionDetails campaignId
Type: string

Campaign id to which this promotion is associated
Example:

"7575785"

root items Item prices promotionDetails title
Type: string

A human readable description explaining the promotions eligibility according to chosen language
Example:

"Achetez 3 articles et obtenez 10% de réduction"

root items Item prices promotionDetails alternateProductId
Type: string

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
Example:

"9898989"

root items Item prices quotePrice

Price

Type: object

This is the product unit price that the customer will pay, without taxes, after applying the quote discount.
Example:

{
    "amount": 900,
    "scale": 2,
    "currency": "EUR"
}

root items Item prices quotePrice amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root items Item prices quotePrice scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root items Item prices quotePrice currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root items Item prices specialPriceAgreement

SpecialPriceAgreement

Type: object

Special price agreement applied to this item
Example:

{
    "id": "47384781",
    "title": "SPA 1 cheaper than base and SPA 2"
}

root items Item prices specialPriceAgreement id
Type: string

Identifier of the special price agreement
Example:

"47384781"

root items Item prices specialPriceAgreement title
Type: string

Title of the special price agreement
Example:

"SPA 1 cheaper than base and SPA 2"

root items Item prices context

PriceContext

Type: object

Details about the type of this price.
Example:

{
    "id": "47384781",
    "title": "SPA 1 cheaper than base and SPA 2",
    "type": "SPECIAL_PRICE_AGREEMENT"
}

root items Item prices context id
Type: string

an identifier of the contract or project related to this price
Example:

"7575785"

root items Item prices context title
Type: string

A short title for this price according the selected language of the customer (Accept-Language)
Example:

"Contract schneider"

root items Item prices context type
Type: enum (of string)

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)
- MARKETPLACE for products that are from marketplace

Must be one of:

  • "SPECIAL_PRICE_AGREEMENT"
  • "PROJECT"
  • "STANDARD"
  • "MARKETPLACE"

Example:

"SPECIAL_PRICE_AGREEMENT"

root items Item prices taxes
Type: array

List of taxes to be applied to net price or promotional net price in case of promotion

 No Additional Items

Each item of this array must be:

root items Item prices taxes Tax

Tax

Type: object

Contains information about a tax. May contain a percentage or a taxAmount or both.

root items Item prices taxes Tax type
Type: string

The type of the tax.
Example:

"VAT"

root items Item prices taxes Tax surcharge
Type: boolean

Is the tax applied as a surcharge or not (non-surcharge taxes apply to the price including surcharges).
Example:

false

root items Item prices taxes Tax taxAmount

Price

Type: object

Amount of the tax
Example:

{
    "amount": 2160,
    "scale": 2,
    "currency": "EUR"
}

root items Item prices taxes Tax taxAmount amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root items Item prices taxes Tax taxAmount scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root items Item prices taxes Tax taxAmount currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root items Item prices taxes Tax percentage
Type: number

Percentage of the tax
Example:

20

Example:

{
    "type": "VAT",
    "surcharge": false,
    "percentage": 20
}

root items Item prices itemPrice

Price

Type: object

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
Example:

{
    "amount": 1800,
    "scale": 2,
    "currency": "EUR"
}

root items Item prices itemPrice amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root items Item prices itemPrice scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root items Item prices itemPrice currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root items Item prices itemTaxes
Type: array

List of taxes to be applied to item price

 No Additional Items

Each item of this array must be:

root items Item prices itemTaxes Tax

Tax

Type: object

Contains information about a tax. May contain a percentage or a taxAmount or both.

root items Item prices itemTaxes Tax type
Type: string

The type of the tax.
Example:

"VAT"

root items Item prices itemTaxes Tax surcharge
Type: boolean

Is the tax applied as a surcharge or not (non-surcharge taxes apply to the price including surcharges).
Example:

false

root items Item prices itemTaxes Tax taxAmount

Price

Type: object

Amount of the tax
Example:

{
    "amount": 2160,
    "scale": 2,
    "currency": "EUR"
}

root items Item prices itemTaxes Tax taxAmount amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root items Item prices itemTaxes Tax taxAmount scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root items Item prices itemTaxes Tax taxAmount currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root items Item prices itemTaxes Tax percentage
Type: number

Percentage of the tax
Example:

20

Example:

{
    "type": "VAT",
    "surcharge": false,
    "taxAmount": {
        "amount": 360,
        "scale": 2,
        "currency": "EUR"
    },
    "percentage": 20
}

root items Item prices itemPriceIncludingTaxes

Price

Type: object

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
Example:

{
    "amount": 2160,
    "scale": 2,
    "currency": "EUR"
}

root items Item prices itemPriceIncludingTaxes amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root items Item prices itemPriceIncludingTaxes scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root items Item prices itemPriceIncludingTaxes currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root items Item quoteLineItemId
Type: string

The identifier of the line item within the quote in the OpCo system. It can be an alpha numeric value.
Example:

"4999569661752721026"

root items Item itemType
Type: enum (of string) Default: "PRODUCT"

Different types of line items :
* PRODUCT - when the item contains a product available in spark catalog
* PROMOTION - when the line item is a cart promotion

Must be one of:

  • "PRODUCT"
  • "PROMOTION"
  • "OFFLINE_PRODUCT"

Example:

"PRODUCT"

root items Item relatedItemsIds
Type: array of string

A list of item ids related to the current item. In case of promotion, they refer to the items that triggered the promotion

 No Additional Items

Each item of this array must be:

root items Item relatedItemsIds relatedItemsIds items
Type: string

Example:

"1234"

root items Item source
Type: enum (of string)

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

Must be one of:

  • "SPARK"
  • "OPCO"
  • "MARKETPLACE"

Example:

"SPARK"

root items Item product

Product

Type: object

Details of the product.

root items Item product productId
Type: string

unique product identifier.
Example:

"9554961192345"

root items Item product opcoProductId
Type: string

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
Example:

"732D16"

root items Item product offlineProduct
Type: object

Offline product details.
Example:

{
    "brandName": "Legrand",
    "productTitle": "BATTERY CABINETS"
}

root items Item product offlineProduct productTitle
Type: string

short description of the product
Example:

"LIGHT 274498 Metal Halide Lamp"

root items Item product offlineProduct brandName
Type: string

Brand name
Example:

"SASS"

root items Item quantity
Type: integer

number of units added to the cart.
Example:

2

root items Item lineCuts
Type: array

In Pilot A list of cut items representing the number of same-length cuts of an item

 No Additional Items

Each item of this array must be:

root items Item lineCuts LineCuts

LineCuts

Type: object

Represents a line cut

root items Item lineCuts LineCuts id
Type: string

The id of the cut

Must match regular expression: ^[0-9]+$
Example:

"17050283147243520"

root items Item lineCuts LineCuts cutGroupId
Type: string

The id of the cut group

Must match regular expression: ^[0-9]+$
Example:

"17050283147243520"

root items Item lineCuts LineCuts numberOfCuts
Type: integer

The quantity of cuts for the specified length.

Value must be greater or equal to 1


Example:

3

root items Item lineCuts LineCuts length
Type: integer

The length of the cable cut in order unit in the product ordering detail.

Value must be greater or equal to 1


Example:

10

root items Item lineCuts LineCuts reelOption
Type: string

The reel option selected by the customer for a cuttable item. Possible values are described here.
Example:

"COILED"

Examples:

{
    "id": "1",
    "cutGroupId": "1",
    "numberOfCuts": 2,
    "length": 3,
    "reelOption": "COILED"
}

{
    "id": "2",
    "cutGroupId": "1",
    "numberOfCuts": 4,
    "length": 2,
    "reelOption": "SPOOLED"
}

{
    "id": "3",
    "cutGroupId": "2",
    "numberOfCuts": 1,
    "length": 10,
    "reelOption": "SPOOLED"
}

Examples:

{
    "id": "47138067260809216",
    "productId": "3675925",
    "itemType": "PRODUCT",
    "source": "SPARK",
    "quantity": 2,
    "prices": {
        "netPrice": {
            "amount": 1000,
            "scale": 2,
            "currency": "EUR"
        },
        "listPrice": {
            "amount": 800,
            "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"
        },
        "listPrice": {
            "amount": 800,
            "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"
        },
        "listPrice": {
            "amount": 800,
            "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"
        }
    }
}

root coupons
Type: array

List of coupons applied to the cart.

 No Additional Items

Each item of this array must be:

root coupons Coupon

Coupon

Type: object

This object represents a coupon into cart

root coupons Coupon id
Type: string

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]+$
Example:

"2196602318024039368"

root coupons Coupon code
Type: string

The coupon code
Example:

"SONEPAR_BIRTHDAY23"

root coupons Coupon description
Type: string

A description of the coupon
Example:

"50% discount on cart because it is our birthday"

root coupons Coupon discount

Price

Type: object

The discount provided by the coupon
Example:

{
    "amount": 5000,
    "scale": 2,
    "currency": "EUR"
}

root coupons Coupon discount amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root coupons Coupon discount scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root coupons Coupon discount currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root coupons Coupon exclusive
Type: boolean

A flag showing whether or not the presence of other coupons is tolerated
Example:

true

root coupons Coupon relatedItemsIds
Type: array of string

A list of item ids related to the coupon.

 No Additional Items

Each item of this array must be:

root coupons Coupon relatedItemsIds relatedItemsIds items
Type: string

Examples:

"1234"

"5647"

root coupons Coupon messages
Type: array

Informations about the coupon

 No Additional Items

Each item of this array must be:

root coupons Coupon messages Message

Message

Type: object

This object represents a business message to show to the end user. A message could contain either a code or a text.

root coupons Coupon messages Message allOf item 0
Type: object

root coupons Coupon messages Message allOf item 0 severity
Type: enum (of string)

the severity of the message that could be used to decide on message formatting

Must be one of:

  • "INFO"
  • "WARN"
  • "ERROR"

Example:

"INFO"

root coupons Coupon messages Message allOf item 0 isBlocker
Type: boolean

A 'blocker' message prevents the redirection to the checkout page. This flag is set to 'true' when the message requires customer attention.
Example:

true
root coupons Coupon messages Message allOf item 1

root coupons Coupon messages Message allOf item 1 oneOf MessageCode

MessageCode

Type: object

root coupons Coupon messages Message allOf item 1 oneOf MessageCode code
Type: enum (of string)

the code of the message

Must be one of:

  • "ITEM_REMOVED"
  • "ITEM_ADDED"
  • "ITEM_PRICES_CHANGED"
  • "ITEM_QUANTITY_CHANGED"
  • "COUPON_REMOVED"
  • "ITEM_REEL_OPTION_CHANGED"
  • "MULTI_SPA_IN_GROUP_REJECTED"

Example:

"ITEM_REMOVED"
root coupons Coupon messages Message allOf item 1 oneOf MessageText

MessageText

Type: object

root coupons Coupon messages Message allOf item 1 oneOf MessageText text
Type: string

the text of the message
Example:

"we would aim to provide all products to you by tomorrow"

Examples:

{
    "severity": "WARN",
    "isBlocker": false,
    "text": "15? stil remaining before applying coupon"
}

{
    "severity": "WARN",
    "isBlocker": false,
    "text": "The coupon will expire soon"
}

Example:

{
    "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"
        }
    ]
}

root contributors
Type: array

The list of cart contributors

 No Additional Items

Each item of this array must be:

root contributors Contributor

Contributor

Type: object

root contributors Contributor email
Type: string

The contributor's email
Example:

"john.doe@sonepar.com"

root contributors Contributor fullName
Type: string

The contributor's full name
Example:

"John Doe"

root contributors Contributor creator
Type: boolean

A flag to define whether the contributor is the creator of the cart or not
Example:

true

root contributors Contributor validator
Type: boolean

A flag to define whether the contributor is a validator of the cart or not
Example:

false

root contributors Contributor onbehalf
Type: boolean

A flag to define whether the contributor is using an onbehalf session on or not
Example:

false

Examples:

{
    "contactId": "14569778234085376",
    "email": "john.doe@sonepar.com",
    "fullName": "John Doe",
    "creator": true,
    "validator": false,
    "onbehalf": false
}

{
    "email": "jane.doe@sonepar.com",
    "fullName": "Jane Doe",
    "creator": false,
    "validator": true,
    "onbehalf": true
}

root totalPrice

Price

Type: object

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.
Example:

{
    "amount": 13800,
    "scale": 2,
    "currency": "EUR"
}

root totalPrice amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalPrice scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalPrice currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalPriceExcludingPromotions

Price

Type: object

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.
Example:

{
    "amount": 1400,
    "scale": 2,
    "currency": "EUR"
}

root totalPriceExcludingPromotions amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalPriceExcludingPromotions scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalPriceExcludingPromotions currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalPromotions

Price

Type: object

The total discount (Promotions + Coupons) applied to the cart. This field is included in the response only if the cart contains items.
Example:

{
    "amount": 7000,
    "scale": 2,
    "currency": "EUR"
}

root totalPromotions amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalPromotions scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalPromotions currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalSurchargeTaxes

Price

Type: object

The surchage taxes of items added to the cart. This field is included in the response only if the cart contains items.
Example:

{
    "amount": 200,
    "scale": 2,
    "currency": "EUR"
}

root totalSurchargeTaxes amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalSurchargeTaxes scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalSurchargeTaxes currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalPriceIncludingSurcharges

Price

Type: object

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.
Example:

{
    "amount": 14000,
    "scale": 2,
    "currency": "EUR"
}

root totalPriceIncludingSurcharges amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalPriceIncludingSurcharges scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalPriceIncludingSurcharges currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalPriceIncludingSurchargesAndShipping

Price

Type: object

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.
Example:

{
    "amount": 14015,
    "scale": 2,
    "currency": "EUR"
}

root totalPriceIncludingSurchargesAndShipping amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalPriceIncludingSurchargesAndShipping scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalPriceIncludingSurchargesAndShipping currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalShippingCosts

Price

Type: object

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.
Example:

{
    "amount": 15,
    "scale": 2,
    "currency": "EUR"
}

root totalShippingCosts amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalShippingCosts scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalShippingCosts currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalPriceIncludingTaxes

Price

Type: object

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.
Example:

{
    "amount": 18000,
    "scale": 2,
    "currency": "EUR"
}

root totalPriceIncludingTaxes amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalPriceIncludingTaxes scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalPriceIncludingTaxes currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalPriceAllIncluded

Price

Type: object

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.
Example:

{
    "amount": 18015,
    "scale": 2,
    "currency": "EUR"
}

root totalPriceAllIncluded amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalPriceAllIncluded scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalPriceAllIncluded currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalVatByPercentage
Type: array

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 Items

Each item of this array must be:

root totalVatByPercentage Tax

Tax

Type: object

Contains information about a tax. May contain a percentage or a taxAmount or both.

root totalVatByPercentage Tax type
Type: string

The type of the tax.
Example:

"VAT"

root totalVatByPercentage Tax surcharge
Type: boolean

Is the tax applied as a surcharge or not (non-surcharge taxes apply to the price including surcharges).
Example:

false

root totalVatByPercentage Tax taxAmount

Price

Type: object

Amount of the tax
Example:

{
    "amount": 2160,
    "scale": 2,
    "currency": "EUR"
}

root totalVatByPercentage Tax taxAmount amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root totalVatByPercentage Tax taxAmount scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root totalVatByPercentage Tax taxAmount currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

root totalVatByPercentage Tax percentage
Type: number

Percentage of the tax
Example:

20

Examples:

{
    "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
}

root discountDetails
Type: array

Give the detail of all discounts applied to the cart

 No Additional Items

Each item of this array must be:

root discountDetails DiscountDetail

DiscountDetail

Type: object

root discountDetails DiscountDetail code
Type: string

code identifying the discount. Equivalent to 'productId' when the discount is given by a COUPON and 'title' when it is given by PROMOTION
Example:

"WINTER_2022"

root discountDetails DiscountDetail type
Type: enum (of string)

Indicating the type of the discount

Must be one of:

  • "COUPON"
  • "PROMOTION"

Example:

"COUPON"

root discountDetails DiscountDetail discount

Price

Type: object

amount of the discount, in absolute value
Example:

{
    "amount": 25000,
    "scale": 2,
    "currency": "EUR"
}

root discountDetails DiscountDetail discount amount
Type: integerFormat: int64

Unscaled price amount
Example:

20000

root discountDetails DiscountDetail discount scale
Type: integerFormat: int32

the scale to be applied on the amount
Example:

2

root discountDetails DiscountDetail discount currency
Type: string

the currency code following ISO 4217 standard 3 letter in which the prices are being displayed

Must be at least 3 characters long

Must be at most 3 characters long


Example:

"EUR"

Example:

{
    "code": "WINTER_2022",
    "type": "COUPON",
    "discount": {
        "amount": 5000,
        "scale": 2,
        "currency": "EUR"
    }
}

root messages
Type: array

An array of message to display to the end user related to the cart

 No Additional Items

Each item of this array must be:

root messages Message

Message

Type: object

This object represents a business message to show to the end user. A message could contain either a code or a text.

root messages Message allOf item 0
Type: object

root messages Message allOf item 0 severity
Type: enum (of string)

the severity of the message that could be used to decide on message formatting

Must be one of:

  • "INFO"
  • "WARN"
  • "ERROR"

Example:

"INFO"

root messages Message allOf item 0 isBlocker
Type: boolean

A 'blocker' message prevents the redirection to the checkout page. This flag is set to 'true' when the message requires customer attention.
Example:

true
root messages Message allOf item 1

root messages Message allOf item 1 oneOf MessageCode

MessageCode

Type: object

root messages Message allOf item 1 oneOf MessageCode code
Type: enum (of string)

the code of the message

Must be one of:

  • "ITEM_REMOVED"
  • "ITEM_ADDED"
  • "ITEM_PRICES_CHANGED"
  • "ITEM_QUANTITY_CHANGED"
  • "COUPON_REMOVED"
  • "ITEM_REEL_OPTION_CHANGED"
  • "MULTI_SPA_IN_GROUP_REJECTED"

Example:

"ITEM_REMOVED"
root messages Message allOf item 1 oneOf MessageText

MessageText

Type: object

root messages Message allOf item 1 oneOf MessageText text
Type: string

the text of the message
Example:

"we would aim to provide all products to you by tomorrow"

root persistentMessages
Type: array

An array of persistent messages to display to the end user related to the cart

 No Additional Items

Each item of this array must be:

root persistentMessages PersistentMessage

PersistentMessage

Type: object

This object contains all mandatory informations to show to the end user persistent message. A persistent message is showed to the user until this last acknowledges it

root persistentMessages PersistentMessage id
Type: string

Identifier used to access to the persistent message
Example:

"123456789"

root persistentMessages PersistentMessage operation
Type: enum (of string)

The operation performed which has raised the message

Must be one of:

  • "BULK_ADD_ITEMS"

Example:

"BULK_ADD_ITEMS"

root persistentMessages PersistentMessage code
Type: enum (of string)

The error code

Must be one of:

  • "ITEMS_NOT_ADDED"

Example:

"ITEMS_NOT_ADDED"

root persistentMessages PersistentMessage reasonCode
Type: enum (of string)

The reason that has made the error happened

Must be one of:

  • "PRODUCT_NOT_FOUND"
  • "PRICE_NOT_FOUND"
  • "TECHNICAL_FAILURE"
  • "PRODUCT_BAD_QUANTITY"
  • "CART_NOT_FOUND"
  • "BULK_ADD_ITEMS_NOT_FOUND"

Example:

"PRODUCT_NOT_FOUND"

root persistentMessages PersistentMessage additionalInfo
Type: string

A short text dealing additional informations about the message
Example:

"related products : [4789651], [9820367], [39852330]"