Skip to main content

Documentation Portal

Product - Customisation

This feature enables you to link a product with a customisation or add-on (such as engraving or a special setting) that incurs an additional fee or price.

To set up this relationship, modify the getCheckoutCartInfo request:

  • No changes are required to the parent product.

  • Set the customisation or add-on product as follows:

    • Set ParentCartItemId to the CartItemId of the parent parent product.

    • Set the productCartItemOptionId to denote the nature of this product add-on, such as "Engraving."

    • If the customisation or add-on is not a distinct physical product, set IsVirtual to true in your getCheckoutCartInfo.

Note

By default, the customisation or add-on is displayed on separate lines on the checkout page. If you require them to appear on the same line beneath the parent product, reach out to the Global-e design team for assistance. Additionally, we can configure the transactional emails to showcase the customisation or add-on beneath the parent product instead of displaying them on separate lines.

Example:

{
	"productsList": [
		{
			"ProductCode": "ProductCode",
			"CartItemId": "line 1",
			"Name": "Product Name",
			"NameEnglish": "Product Name",
			"Description": "Description",
			"DescriptionEnglish": "Description",
			"ImageURL": "https://domain/img/imageName.jpg",
			"ImageWidth": "",
			"ImageHeight": "",
			"OriginalListPrice": 100,
			"OriginalSalePrice": 100,
			"OrderedQuantity": 1
		},
		{
			"ProductCode": "ProductCode",
			"CartItemId": "line 2",
			"CartItemOptionId": "Engraving",
			"ParentCartItemId": "line 1",
			"Name": "Option Name",
			"NameEnglish": "Option Name",
			"Description": "Description",
			"DescriptionEnglish": "Description",
			"ImageURL": "https://domain/img/imageName.jpg",
			"ImageWidth": "",
			"ImageHeight": "",
			"OriginalListPrice": 40,
			"OriginalSalePrice": 40,
			"OrderedQuantity": 1,
			"IsVirtual": true
		}
	]
}