E-Commerce Integration

This topic provides information about how you can integrate your E-Commerce Solution with the Connected Cloud API


Domain information

The domain name that should be used to register an application using this solution is: ecommerce.


Download JSON schemas

Data Contracts


Customer

Customer basic data and details for eCommerce integration Sage data delivery

Property Type Required Description
id string Yes Unique identifier of the customer
idNumber string No ID number or tax identification number
firstName string Yes First name
lastName string Yes Last name
email string Yes eMail address
addresses address [...] Yes Address of the customer
type string No Type of customer
currency string No Preferred ISO4217 currency code
tax number No Tax rate to be applied for the customer (e.g., for customers within or outside the EU)
surcharge boolean No True when the customer should be charged with any additional fee or tax surcharge
timestamp string Yes Timestamp of the last update of the customer (UTC format)

Product

Product name, description, price and other details Sage data delivery

Property Type Required Description
id string Yes Unique identifier of the product
reference string No Reference
name string Yes Name of the product
shortDescription string No Short description
longDescription string No Long description
barCodeType string No Type of barcode used for the product
barCode string No Barcode digits, according to the type specified
netPrice number Yes Net price, without taxes
tax number Yes Tax rate
discount number No Discount rate
discountByUnit boolean Yes True when the discount should be applied by unit. False when the discount should be applied to the total price
surcharge boolean No True when the product should be charged with any additional fee or tax surcharge
dateAdded string No Date when the item was initially added to the catalog (UTC format)
brand string No Brand name of the product
category string No Could be a string with using any separator, like backslash
available boolean Yes True when the product is publicly available to be sold
relatedItems string No List of ids of other products related with this (comma separated)
variantCombinationId string No Unique identifier for this product and variant values
variant1Type string No First feature type or name (e.g. Size). If Variants are used, the product Id should be the same for all variants combination and use a different unique variantCombinationId
variant1Value string No First feature value (e.g. XL). If Variants are used, the product Id should be the same for all variants combination and use a different unique variantCombinationId
variant2Type string No Second feature type or name (e.g. Color). If Variants are used, the product Id should be the same for all variants combination and use a different unique variantCombinationId
variant2Value string No Second feature value (e.g. Blue). If Variants are used, the product Id should be the same for all variants combination and use a different unique variantCombinationId
timestamp string Yes Timestamp of the last update of the product (UTC format)

Product picture

Picture information for each product Sage data delivery

Property Type Required Description
productId string Yes Identifier of the product
order number No Order to follow to show the pictures
description string No Description of the product picture
picture string Yes Image content (base64 format)
variantCombinationId string No Unique identifier for this product and variant values
timestamp string Yes Timestamp of the last update of the picture (UTC format)

Product stock

Stock definition for a product Sage data delivery

Property Type Required Description
productId string Yes Product identifier
stock number Yes Amount of units available
unitName string No Name for the units specified for this product (boxes, liters, units, …)
minimumToSell number No Minimum number of units to sell
variantCombinationId string No Unique identifier for this product and variant values
timestamp string Yes Timestamp of the last update of the product (UTC format)

Product special price

Special price and condition for a product Sage data delivery

Property Type Required Description
productId string No Identifier of the product
dateFrom string No Starting date where the discount is applicable
dateTo string No End date where the discount is applicable
discount number No Discount to be applied
netPrice number No Special net price for the product
pricePolicy string Yes Indicate the special policy price to apply: byPrice (the netPrice should be applied), byDiscount (the discount should be applied over the price in the product definition, byPriceAndDiscount (the discount should be applied over the net price, both given in the special price record)
discountByUnit boolean Yes True when the discount should be applied by unit. False when the discount should be applied to the total price
quantityFrom number No Minimum quantity of the product to buy to get the discount
quantityTo number No Maximum quantity of the product to buy to get the discount
totalSpentFrom number No Minimum ammount of money spent to get the discount
totalSpentTo number No Maximum ammount of money spent to get the discount
brand string No Brand to apply the discount to all its items to
category string No Category to apply the discounts to all its items to
customerId string No Customer to apply the special price/discount to
variantCombinationId string No Unique identifier for this product and variant values
timestamp string Yes Timestamp of the last update of the special discount/price (UTC format)

Order result

Result of the ingestion of a sale order Sage data delivery

Property Type Required Description
originatorIdentifier string Yes Third party order number
productIdentifier string No Order number given by the Sage application, once the order has been accepted
state string Yes Ingestion status for the order
failureReason string[...] No List of human readable descriptions of the failure

Order

Sale order details Sage data ingestion

Property Type Required Description
id string Yes Order number, given by the third party. Should be unique
orderDate string Yes Date of the order (UTC format)
eta string No Estimated Time of Arrival (UTC format)
orderStatus string No Status of the order (pending, delivered, ...)
deliveryAddress address Yes Delivery address for the order
invoiceAddress address Yes Invoice address for the order
customer customer Yes
discount number Yes Total ammount of the discount applied
currencyRate number Yes Currency rate applied
paymentMethod string Yes Payment method applied
totalShipping number Yes Shipping costs, without taxes
taxRateForShippingCosts number Yes Tax rate to be applied for the shipping costs
total number Yes Total cost of the order (including shipping costs and taxes)
lines orderline [...] Yes Order detail lines
comments string No Additional comments
timestamp string Yes Timestamp of the last update of the order (UTC format)

Address

Address data and details

Property Type Required Description
id string Yes Unique identifier for the address
contactName string No Contact name for this address
address1 string Yes Address details, line 1
address2 string No Address details, line 2
city string Yes City of the address
country string Yes Country ISO code of the address (ISO 3166-1 alpha-3)
state string No State (if applies) of the address
region string No Region (if applies) of the address
postCode string Yes Postal code
telephone1 string No Main telephone number
telephone2 string No Additional telephone number
timestamp string Yes Timestamp of the last update of the address (UTC format)

Order line

Detail for each sale order line

Property Type Required Description
id string Yes Unique identifier for the order line
productId string Yes Unique identifier of the product
reference string No Reference of the product
price number Yes Price, taxes included
tax number Yes Tax rate
discount number No Discount rate
quantity number Yes Quantity of the product
orderToShow number No Position where the line should be presented among the others
variantCombinationId string No Unique identifier for this product and variant values

Supported Regions

Changes history log