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

Orders

Type: array

List of offline orders and online order sent by the datalake team

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root OpCoOrder

OpCoOrder

Type: object

The order details schema

 No Additional Properties

root OpCoOrder opCoOrderId
Type: string

the order id known by the opco and the customer.
Example:

"4999569661752721026"

root OpCoOrder logisticDetails
Type: array

the list of logistic details related to this order

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root OpCoOrder logisticDetails LogisticDetails

LogisticDetails

Type: object

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

{
    "logisticMethod": "DELIVERY",
    "facilityId": 395,
    "deliveryAddress": {
        "addressLine1": "chaussee Verlinden 22",
        "addressLine2": "Apartment 2",
        "city": "Bruges",
        "country": "BEL",
        "postalCode": "0287",
        "addressName": "Building #2",
        "companyName": "Easy Electric",
        "contactFirstName": "John",
        "contactLastName": "Doe",
        "contactPhoneNumber": "+333746573829",
        "deliveryIndication": "Please leave the parcel next the front door.",
        "customerReference": "Ref 364361"
    },
    "logisticOption": {
        "code": "STANDARD",
        "title": "STANDARD delivery",
        "description": "choose this option if you want a fast delivery",
        "cost": {
            "amount": 0,
            "scale": 2,
            "currency": "EUR"
        },
        "logisticScenario": {
            "code": "1_DELIVERY",
            "title": "1 DELIVERY",
            "description": "choose this scenario if you want all your products to be delivered at the same time",
            "cost": {
                "amount": 0,
                "scale": 2,
                "currency": "EUR"
            },
            "shippingGroups": [
                {
                    "status": "DELIVERED",
                    "deliveryDate": "2017-07-21T08:30:22.804Z",
                    "lineItems": [
                        {
                            "quantity": 1,
                            "lineItemId": "1",
                            "itemPrice": {
                                "amount": 1800,
                                "scale": 2,
                                "currency": "EUR"
                            }
                        }
                    ]
                }
            ]
        }
    }
}

root OpCoOrder logisticDetails LogisticDetails logisticMethod
Type: enum (of string)

Logistic method chosen for the cart

Must be one of:

  • "DELIVERY"
  • "PICK_UP"

Example:

"PICK_UP"

root OpCoOrder logisticDetails LogisticDetails lockerFacilityId
Type: string

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

"395"

root OpCoOrder logisticDetails LogisticDetails facilityId
Type: string

Unique identifier of the facility used when logistic method is 'PICK_UP'.
Example:

"395"

root OpCoOrder logisticDetails LogisticDetails cdcFacilityId
Type: string

The id of the CDC from where this cart should be delivered. Needed to compute the right stock into PLP/PDP ....In case of multi CDC, the OpCo may have dynamic computation of the CDC and not only a static relation between branch and CDC.
Example:

"2Z1"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress
Type: object

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

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

root OpCoOrder logisticDetails LogisticDetails deliveryAddress opCoAddressId
Type: string

OpCo internal system's unique identifier for the address. Will be empty of the address is not yet synced with the opco backend system
Example:

"237564557868778"

root OpCoOrder logisticDetails 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:

"chaussee Verlinden 22"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress addressLine2
Type: string

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

"1st floor"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress addressLine3
Type: string

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

"Apparment 2"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress city
Type: string

The city name
Example:

"Bruges"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress region
Type: string

The region name
Example:

"Frandre"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress department
Type: string

The department name
Example:

"N/A"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress country
Type: string

The ISO 3166-1 alpha-3 of the country
Example:

"Belgium"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress postalCode
Type: string

Postal code
Example:

"0287"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress addressName
Type: string

Extra description about the address
Example:

"Building site 1"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress companyName
Type: string

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

"Easy Electric"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress contactFirstName
Type: string

Address contact's first name
Example:

"John"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress contactLastName
Type: string

Address contact's last name
Example:

"Doe"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress contactPhoneNumber
Type: string

Address contact's Phone number (The phone number of the person receiving the delivery)
Example:

"+330287345678"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress deliveryIndication
Type: string

Optional indications or instructions about the delivery
Example:

"Please leave the parcel next the front door"

root OpCoOrder logisticDetails LogisticDetails deliveryAddress customerReference
Type: string

Optional reference about the customer
Example:

"Reference 123"

root OpCoOrder logisticDetails LogisticDetails logisticOption

LogisticOption

Type: object

the logistic option choosed for the selected logistic method (e.g a standard delivery is a logistic option).
Example:

{
    "code": "STANDARD",
    "title": "STANDARD delivery",
    "description": "choose this option if you want a fast delivery",
    "cost": {
        "amount": 0,
        "scale": 2,
        "currency": "EUR"
    },
    "logisticScenario": {
        "code": "1_DELIVERY",
        "title": "1 DELIVERY",
        "description": "choose this scenario if you want all your products to be delivered at the same time",
        "cost": {
            "amount": 0,
            "scale": 2,
            "currency": "EUR"
        },
        "totalPrice": {
            "amount": 2300,
            "scale": 2,
            "currency": "EUR"
        },
        "totalPriceIncludingSurchargesAndShipping": {
            "amount": 1900,
            "scale": 2,
            "currency": "EUR"
        },
        "shippingGroups": [
            {
                "lineItems": [
                    {
                        "quantity": 1,
                        "lineItemId": "1",
                        "itemPrice": {
                            "amount": 1800,
                            "scale": 2,
                            "currency": "EUR"
                        }
                    }
                ]
            }
        ]
    }
}

root OpCoOrder logisticDetails LogisticDetails logisticOption code
Type: string

The code of the logistic option
Example:

"STANDARD"

root OpCoOrder logisticDetails LogisticDetails logisticOption title
Type: string

The title of the logistic option to be displayed to the end user.
Example:

"STANDARD delivery"

root OpCoOrder logisticDetails LogisticDetails logisticOption description
Type: string

The description of the logistic option to be displayed to the end user.
Example:

"choose this option if you want a fast delivery"

root OpCoOrder logisticDetails LogisticDetails logisticOption cost

Price

Type: object

The cost of this logistic option
Example:

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

root OpCoOrder logisticDetails LogisticDetails logisticOption cost amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder logisticDetails LogisticDetails logisticOption cost scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder logisticDetails LogisticDetails logisticOption cost currency
Type: string

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

"EUR"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario

LogisticScenario

Type: object

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

{
    "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": "OPENED",
            "deliveryDate": "2021-10-12T08:30:22.804Z",
            "lineItems": [
                {
                    "quantity": 1,
                    "lineItemId": "1",
                    "itemPrice": {
                        "amount": 1800,
                        "scale": 2,
                        "currency": "EUR"
                    }
                }
            ]
        }
    ]
}

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario code
Type: string

The code of the logistic scenario
Example:

"1_DELIVERY"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario title
Type: string

The title of the logistic scenario to be displayed to the end user.
Example:

"1 DELIVERY"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario description
Type: string

The description of the logistic scenario to display to the end user.
Example:

"choose this scenario if you want all your products to be delivered at the same time"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario cost

Price

Type: object

The cost of this logistic scenario
Example:

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

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario cost amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario cost scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario cost currency
Type: string

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

"EUR"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario totalPrice

Price

Type: object

Total price of the logistic scenario including promotions, surcharges, shipping cost and taxes (vat)
Example:

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

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario totalPrice amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario totalPrice scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario totalPrice currency
Type: string

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

"EUR"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario totalPriceIncludingSurchargesAndShipping

Price

Type: object

Total price of the logistic scenario including promotions, surcharges, shipping cost without taxes (vat)
Example:

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

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario totalPriceIncludingSurchargesAndShipping amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario totalPriceIncludingSurchargesAndShipping scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario totalPriceIncludingSurchargesAndShipping currency
Type: string

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

"EUR"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups
Type: array of object

A list of groups of line items corresponding to the way the order will be fulfilled

 No Additional Items

Each item of this array must be:

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items
Type: object

Order shipment

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items status
Type: string

The status of the shipment.
Example:

"DELIVERED"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items dateChosenByCustomer
Type: boolean Default: "false"

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.

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items deliveryDate
Type: stringFormat: date-time

[Deprecated - Use instead expectedDeliveryDate and expectedDeliveryTime].
Date on which the shipment expected to be delivered.
Example:

"2021-10-12T08:30:22.804Z"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items expectedDeliveryDate
Type: stringFormat: date

Date on which the shipment expected to be delivered.
Example:

"2021-10-12"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items expectedDeliveryTime
Type: string

Time on which the shipment expected to be delivered
Example:

"08:30:22.804Z"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items lineItems
Type: array of object

The line items that are shipped.

 No Additional Items

Each item of this array must be:

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items lineItems lineItems items
Type: object

Optional. The line items that are shipped.

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items lineItems lineItems items lineItemId
Type: string

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

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

"2196602318024039368"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items lineItems lineItems items itemPrice

Price

Type: object

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

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

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items lineItems lineItems items itemPrice amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items lineItems lineItems items itemPrice currency
Type: string

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

"EUR"

Example:

[
    {
        "quantity": 1,
        "lineItemId": "1",
        "itemPrice": {
            "amount": 1800,
            "scale": 2,
            "currency": "EUR"
        }
    }
]

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items documents
Type: array

Documents references associated with this shipping group

 No Additional Items

Each item of this array must be:

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items documents DocumentReference

DocumentReference

Type: object

Information identifying a document and potentially a line within the document for referencing purposes.

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items documents DocumentReference type

DocumentType

Type: enum (of string)

The type of the document

Must be one of:

  • "DELIVERY_NOTES"
  • "INVOICE"

Example:

"INVOICE"

root OpCoOrder logisticDetails LogisticDetails logisticOption logisticScenario shippingGroups shippingGroups items documents DocumentReference createdAt
Type: stringFormat: date-time

Date on which the document has been created, in ISO 8601 format.
Example:

"2017-07-21T08:30:22.804Z"

Example:

[
    {
        "type": "DELIVERY_NOTES",
        "id": "4999569661752721026",
        "createdAt": "2017-07-21T17:32:28Z"
    }
]

Example:

[
    {
        "status": "OPENED",
        "deliveryDate": "2021-10-12T08:30:22.804Z",
        "lineItems": [
            {
                "quantity": 1,
                "lineItemId": "1",
                "itemPrice": {
                    "amount": 1800,
                    "scale": 2,
                    "currency": "EUR"
                }
            }
        ]
    }
]

root OpCoOrder totalAmount

Price

Type: object

The total amount of all the items of the order after applying promotions, without taxes.
Example:

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

root OpCoOrder totalAmount amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder totalAmount scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder totalAmount currency
Type: string

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

"EUR"

root OpCoOrder totalAmountIncludingTaxes

Price

Type: object

The total price of all items of the order applying promotions, including all taxes.
Example:

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

root OpCoOrder totalAmountIncludingTaxes amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder totalAmountIncludingTaxes scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder totalAmountIncludingTaxes currency
Type: string

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

"EUR"

root OpCoOrder totalAmountWithSurcharge

Price

Type: object

The total price of all items of the order including promotions and including surcharges.
Example:

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

root OpCoOrder totalAmountWithSurcharge amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder totalAmountWithSurcharge scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder totalAmountWithSurcharge currency
Type: string

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

"EUR"

root OpCoOrder totalByTax
Type: array

The total amount of each tax.

 No Additional Items

Each item of this array must be:

root OpCoOrder totalByTax Tax

Tax

Type: object

contains the tax informations with both percentage or exact amount as preferable.

root OpCoOrder totalByTax Tax oneOf item 0
Type: object

A tax with a fix amount

root OpCoOrder totalByTax Tax oneOf item 0 taxAmount

Price

Type: object

contains the amount informations based on the type of prices we might have

root OpCoOrder totalByTax Tax oneOf item 0 taxAmount amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder totalByTax Tax oneOf item 0 taxAmount scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder totalByTax Tax oneOf item 0 taxAmount currency
Type: string

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

"EUR"

root OpCoOrder totalByTax Tax oneOf item 0 type
Type: string

type of tax which is applicable to the underlying product.
Example:

"VAT"

root OpCoOrder totalByTax Tax oneOf item 0 isSurcharge
Type: boolean

This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
Example:

true
root OpCoOrder totalByTax Tax oneOf item 1
Type: object

A tax represented by a percentage.

root OpCoOrder totalByTax Tax oneOf item 1 percentage
Type: number

the percentage of the net price
Example:

20.0

root OpCoOrder totalByTax Tax oneOf item 1 type
Type: string

type of tax which is applicable to the underlying product.
Example:

"VAT"

root OpCoOrder totalByTax Tax oneOf item 1 isSurcharge
Type: boolean

This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
Example:

true

The following properties are required:

  • type

Example:

[
    {
        "type": "VAT",
        "isSurcharge": false,
        "taxAmount": {
            "amount": 320,
            "scale": 2,
            "currency": "EUR"
        }
    },
    {
        "type": "ECOTAXE",
        "isSurcharge": true,
        "taxAmount": {
            "amount": 226,
            "scale": 2,
            "currency": "EUR"
        }
    }
]

root OpCoOrder documents
Type: array

Documents references associated with the order

 No Additional Items

Each item of this array must be:

root OpCoOrder documents DocumentReference

DocumentReference

Type: object

Information identifying a document and potentially a line within the document for referencing purposes.

root OpCoOrder documents DocumentReference type

DocumentType

Type: enum (of string)

The type of the document

Must be one of:

  • "DELIVERY_NOTES"
  • "INVOICE"

Example:

"INVOICE"

root OpCoOrder documents DocumentReference id
Type: string

The id of the document
Example:

"4999569661752721026"

root OpCoOrder documents DocumentReference createdAt
Type: stringFormat: date-time

Date on which the document has been created, in ISO 8601 format.
Example:

"2017-07-21T08:30:22.804Z"

Example:

[
    {
        "type": "INVOICE",
        "id": "4999569661752721026",
        "createdAt": "2017-07-21T17:32:28Z"
    }
]

root OpCoOrder sparkOrderId
Type: string

The order id generated by the spark plateform.
Example:

"4999569661752721026"

root OpCoOrder opcoId
Type: string

tenant identifier for an Opco in SPARK multitenant platform
Example:

"BEL-CEBEO"

root OpCoOrder opcoCartId
Type: string

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

"1234"

root OpCoOrder orgId
Type: string

Optional field, needed by OpCo organised with a regional model or commercial organisation. It can be used to filter or route based on the orgId.
Examples:

"org123"

"SNE"

root OpCoOrder salesChannel

SalesChannel

Type: enum (of string)

The sales channel where the order is placed

Must be one of:

  • "ESHOP"
  • "MOBILE_APP"
  • "SYSTEM_TO_SYSTEM"
  • "STORE"
  • "BY_PHONE"

Example:

"ESHOP"

root OpCoOrder status
Type: string

The global status of the order.
Example:

"DELIVERED"

root OpCoOrder placedDate
Type: stringFormat: date-time

The date when the order was placed
Example:

"2021-10-12T08:30:22.804Z"

root OpCoOrder lastModificationDate
Type: stringFormat: date-time

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

"2021-10-12T08:30:22.804Z"

root OpCoOrder accountId
Type: string

The opco account id of the customer.
Example:

"12345"

root OpCoOrder contributors
Type: array of object

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

Each item of this array must be:

root OpCoOrder contributors contributors items
Type: object

Example:

[
    {
        "fullName": "John Smith",
        "email": "john.smith@mycompany.com",
        "creator": true
    },
    {
        "fullName": "John Validator",
        "email": "john.validator@mycompany.com"
    }
]

root OpCoOrder contributors contributors items fullName
Type: string

The full name of a contributor.
Example:

"John Smith"

root OpCoOrder contributors contributors items email
Type: string

The email of a contributor. this is the identifier of the user on spark
Example:

"john.smith@mycompany.com"

root OpCoOrder contributors contributors items creator
Type: boolean Default: "false"

A boolean that when is true means that the current contributor is the creator of the cart from where this order is created.
Example:

"false"

root OpCoOrder contributors contributors items onbehalf
Type: boolean Default: "false"

A boolean that when is true means that the current contributor is an associate doing the action on behalf of the end user.
Example:

"false"

root OpCoOrder billingAddress

Address

Type: object

The billing address
Example:

{
    "opCoAddressId": "13543678",
    "addressLine1": "chaussee Verlinden 22",
    "addressLine2": "1st floor",
    "addressLine3": "Apparment 2",
    "postalCode": "0287",
    "city": "Bruges",
    "region": "Frandre",
    "department": "N/A",
    "country": "BEL"
}

root OpCoOrder billingAddress opCoAddressId
Type: string

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

"237564557868778"

root OpCoOrder billingAddress addressLine1
Type: string

Should contains the Given name, Surname, the name of the company
Example:

"235 Donaghy Ave"

root OpCoOrder billingAddress addressLine2
Type: string

Should contains the street No, street name, street type

root OpCoOrder billingAddress addressLine3
Type: string

Should contains the Floor

root OpCoOrder billingAddress postalCode
Type: string

The postal code
Example:

"V7P 1E2"

root OpCoOrder billingAddress city
Type: string

The city in which the street address is, and which is in the adminDevison(region)
Example:

"North Vancouver"

root OpCoOrder billingAddress region
Type: string

The region in which the locality is, and which is in the country.
Example:

"BC"

root OpCoOrder billingAddress department
Type: string

The department in which the locality is, and which is in the country.
Example:

"BC"

root OpCoOrder billingAddress country
Type: string

The ISO 3166-1 alpha-3 of the country
Example:

"CAN"

root OpCoOrder lineItems
Type: array

Line items that are ordered.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root OpCoOrder lineItems LineItem

LineItem

Type: object

The order line item

root OpCoOrder lineItems LineItem id
Type: string

The ID of the line item.

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

"4999569661752721026"

root OpCoOrder lineItems LineItem orderedQuantity
Type: integer

Number of items ordered.
Example:

10

root OpCoOrder lineItems LineItem product
Type: object

Product data as seen by customer from the time of the order placement.

root OpCoOrder lineItems LineItem product productId
Type: string

A unique identifier of the product
Example:

"9554961192345"

root OpCoOrder lineItems LineItem product productTitle
Type: string

short description of the product
Example:

"LIGHT 274498 Metal Halide Lamp"

root OpCoOrder lineItems LineItem product brandName
Type: string

Brand name
Example:

"SASS"

root OpCoOrder lineItems LineItem promotionDetails

PromotionDetails

Type: object

Details of the promotion applied to this line item
Example:

{
    "title": "Achete 3 articles et 2 gartuit",
    "alternateProductId": "767867",
    "campaignId": "234"
}

root OpCoOrder lineItems LineItem promotionDetails title
Type: string

A readable description explaining the promotions eligibility received from opco, Send the title according to chosen language
Example:

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

root OpCoOrder lineItems LineItem promotionDetails campaignId
Type: string

campaign id to which this promotion is associated to relative to the standard product id
Example:

"7575785"

root OpCoOrder lineItems LineItem 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 opco
Example:

"9898989"

root OpCoOrder lineItems LineItem prices

Prices

Type: object

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

root OpCoOrder lineItems LineItem 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 OpCoOrder lineItems LineItem prices netPrice amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder lineItems LineItem prices netPrice scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder lineItems LineItem prices netPrice currency
Type: string

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

"EUR"

root OpCoOrder lineItems LineItem prices contractTitle
Type: string

A short title for this price into user language
Example:

"contract schneider"

root OpCoOrder lineItems LineItem prices contractId
Type: string

an identifier of the contract related to this price
Example:

"7575785"

root OpCoOrder lineItems LineItem prices promotionalNetPercentage
Type: number

percentage of discount on net price, If we have this value then promotionalNetPrice is needed also
Example:

10.0

root OpCoOrder lineItems LineItem prices promotionalNetPrice

Price

Type: object

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

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

root OpCoOrder lineItems LineItem prices promotionalNetPrice amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder lineItems LineItem prices promotionalNetPrice scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder lineItems LineItem prices promotionalNetPrice currency
Type: string

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

"EUR"

root OpCoOrder lineItems LineItem 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 OpCoOrder lineItems LineItem prices taxes Tax

Tax

Type: object

contains the tax informations with both percentage or exact amount as preferable.

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 0
Type: object

A tax with a fix amount

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 0 taxAmount

Price

Type: object

contains the amount informations based on the type of prices we might have

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 0 taxAmount amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 0 taxAmount scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 0 taxAmount currency
Type: string

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

"EUR"

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 0 type
Type: string

type of tax which is applicable to the underlying product.
Example:

"VAT"

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 0 isSurcharge
Type: boolean

This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
Example:

true
root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 1
Type: object

A tax represented by a percentage.

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 1 percentage
Type: number

the percentage of the net price
Example:

20.0

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 1 type
Type: string

type of tax which is applicable to the underlying product.
Example:

"VAT"

root OpCoOrder lineItems LineItem prices taxes Tax oneOf item 1 isSurcharge
Type: boolean

This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
Example:

true

The following properties are required:

  • type

Example:

[
    {
        "type": "VAT",
        "isSurcharge": false,
        "percentage": 20.0
    }
]

Example:

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

root OpCoOrder paymentTerms
Type: array

Payment terms associated with the order

 No Additional Items

Each item of this array must be:

root OpCoOrder paymentTerms PaymentTerm

PaymentTerm

Type: object

Terms and conditions by which a payment has been or will be made.

root OpCoOrder paymentTerms PaymentTerm paymentMethod
Type: enum (of string)

The payment method type

Must be one of:

  • "CASH"
  • "CHEQUE"
  • "CREDIT_DEBIT_CARD"
  • "CREDIT_LINE"
  • "PCB_CARD"

Example:

"CREDIT_LINE"

root OpCoOrder paymentTerms PaymentTerm paymentTransactionId
Type: string

The transaction payment id
Example:

"PAY0001"

root OpCoOrder paymentTerms PaymentTerm amount

Price

Type: object

The amount of the payment
Example:

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

root OpCoOrder paymentTerms PaymentTerm amount amount
Type: integer

the actual unscaled amount based on list or customer
Example:

205987

root OpCoOrder paymentTerms PaymentTerm amount scale
Type: integer

the scale to be applied on the unscaled amount
Example:

2

root OpCoOrder paymentTerms PaymentTerm amount currency
Type: string

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

"EUR"

root OpCoOrder paymentTerms PaymentTerm createdAt
Type: stringFormat: date-time

Date on which the payment transaction has been created
Example:

"2017-07-21T08:30:22.804Z"

Example:

[
    {
        "paymentMethod": "CREDIT_LINE",
        "amount": {
            "amount": 10000,
            "scale": 2,
            "currency": "EUR"
        },
        "paymentTransactionId": "12345",
        "createdAt": "2017-07-21T17:32:28Z"
    }
]

root OpCoOrder orderAdditionalInformation
Type: object

Additional information for the order.

root OpCoOrder orderAdditionalInformation purchaseOrder
Type: string

The purchase order.
Example:

"XDFG334322"

root OpCoOrder orderAdditionalInformation cartName
Type: string

The cart name.
Example:

"Site 1 Cart"

root OpCoOrder orderAdditionalInformation project

Project

Type: object

The project associated to the order

root OpCoOrder orderAdditionalInformation project id
Type: string

The identifier of the project

root OpCoOrder orderAdditionalInformation project name
Type: string

The name of the project to display to the customer

root OpCoOrder orderAdditionalInformation quote

Quote

Type: object

The quote associated to the order

root OpCoOrder orderAdditionalInformation quote id
Type: string

The identifier of the quote

root OpCoOrder orderAdditionalInformation quote name
Type: string

The name of the Quote

root OpCoOrder orderAdditionalInformation contactFirstName
Type: string

Contact first name for this order. This field is added by the customer to override the same field into delivery address.
Example:

"Robert"

root OpCoOrder orderAdditionalInformation contactLastName
Type: string

Contact last name for this order. This field is added by the customer to override the same field into delivery address.
Example:

"Fox"

root OpCoOrder orderAdditionalInformation contactPhoneNumber
Type: string

Contact phone number for this order. This field is added by the customer to override the same field into delivery address.
Example:

"+3333333333"

root OpCoOrder orderAdditionalInformation contactEmail
Type: string

Contact email for this order.
Example:

"john.doe@sonepar.com"

root OpCoOrder orderAdditionalInformation priceOnLogisticsNotes
Type: boolean

Choice of showing or not the price on the logistics note.
Example:

false

root OpCoOrder orderAdditionalInformation orderConfirmationRecipients
Type: array of string

An optional emails list that will be used as additional recipients to send the confirmation email of the order

 No Additional Items

Each item of this array must be:

root OpCoOrder orderAdditionalInformation orderConfirmationRecipients orderConfirmationRecipients items
Type: string

root OpCoOrder orderAdditionalInformation notes
Type: array

The notes related to the order.

 No Additional Items

Each item of this array must be:

root OpCoOrder orderAdditionalInformation notes Note

Note

Type: object

Object representing a note

root OpCoOrder orderAdditionalInformation notes Note noteOnInvoice
Type: boolean

Choice of showing or not the note on the invoice.
Example:

true

root OpCoOrder orderAdditionalInformation notes Note noteOnLogisticsNotes
Type: boolean

Choice of showing or not the note on the logistics notes.
Example:

false

root OpCoOrder orderAdditionalInformation notes Note noteText
Type: string

Note added to cart
Example:

"Morning delivery preference"

Example:

[
    {
        "noteOnInvoice": true,
        "noteOnLogisticsNotes": false,
        "noteText": "Morning delivery preference"
    }
]

root OpCoOrder orderAdditionalInformation additionalReferences
Type: array

Additional order information filled by the customer when placing the order or added by the OpCo system during the order processing.

 No Additional Items

Each item of this array must be:

root OpCoOrder orderAdditionalInformation additionalReferences AdditionalReference

AdditionalReference

Type: object

Object representing an additional reference.

root OpCoOrder orderAdditionalInformation additionalReferences AdditionalReference name
Type: string

Name of the additional reference
Example:

"warehouseName"

root OpCoOrder orderAdditionalInformation additionalReferences AdditionalReference value
Type: string

Value of the additional reference filled by the customer
Example:

"P570629"

Example:

[
    {
        "name": "warehouseName",
        "value": "Z.I. Fourviere"
    }
]