Documentation Portal

This section describes the Globale Products Job as part of the default/basic functionality of the Global-e SFCC cartridge. Globale Products Job pulls product restrictions and end-customer country product VAT rates (if it is configured on Global-e side) and stores them in a product’s custom attributes:

This section describes the GlobaleOrderNotifications job as part of the default/basic functionality of the Global-e SFCC cartridge.

The job sends order update notifications from SFCC to Global‑e (in case such notifications are in the integration scope).

The job contains multiple job steps that handle different types of notifications:

When an order is cancelled on the SFCC side it might be required to send the order status update notification from the SFCC to Global-e (depending on the integration scope and the solution).

The job step handles such cases.

When an order is dispatched to Global-e it might be required to send the order dispatch update notification from the SFCC to Global-e (depending on the integration scope and the solution).

The job step handles such cases.

When an order refund should be issued it might be required to send the CreateOrderRefund notification from the SFCC to Global-e (depending on the integration scope and the solution).

The job step handles such cases.

The job step sends RMA update notifications from the SFCC to Global‑e (depending on the integration scope and the solution).

Usecase: provide the internal RMA number to Global-e instead of suing the Global-e one.

The job step handles such cases.

Additional documentation could be found in the document “Global‑e SFCC Cartridge Return Merchandise Authorization“.

This section describes the "GlobaleCatalogFeed" job, which is part of the default functionality of the Global-e SFCC cartridge.

As part of the integration process, Global‑e requires that you perform a periodic export of your products catalog to handle product classification and restrictions.

The "GlobaleCatalogFeed" job generates a Catalog Feed and uploads it to an SFTP folder configured under Global‑e Site Preferences, from which Global‑e pulls the updated catalog information.

Due to SFCC technical limitations, the "GlobaleCatalogFeed' job can only:

Information and error logs are written respectively to the "GLOBALE_INFO" or/and "GLOBALE_ERROR" custom log to identify any issues with given catalog data and upload configurations. 

The GlobaleCatalogFeed job picks up each product that has been modified or created since the last job run time and saves them to a CSV file. This CSV file is pushed to a pre-defined SFTP folder; this folder can be hosted by either, the merchant or Global‑e.

A different periodic service, hosted on the Global‑e servers, looks for the new catalogue export CSV file and runs each new and updated product through various classification processes.

Another SFCC job is scheduled to query the Global‑e API and returns the product classification and restriction information to SFCC.

As part of the installation, set up the GlobaleCatalogFeed Job to run periodically. This is usually set to once a day but can be adjusted according to your catalog update frequency.

Mandatory fields:

The following table details the list of Catalog Feed columns. Make sure to be represented them in the Catalog CSV file. Even if the column is not mandatory, Global‑e strongly recommends adding it to the CSV Catalog file.

The GlobaleCatalogFeed Job is part of the standard functionality provided in the Global‑e SFCC cartridge.

The catalog feed has two components (Job steps): Generate Catalog Feed and Upload Catalog Feed.

Generate Catalog Feed	Upload Catalog Feed
This Job Step is responsible for generating the Catalog Feed in CSV format based on the parameters configured in the Global-e Site Preferences and for placing the result file into the SFCC IMPEX folder.	This Job Step is responsible for uploading the Catalog Feed file placed in the SFCC IMPEX folder to the SFTP folder configured in the Global-e Site Preferences so that Global-e can pull this file from that location and import it for further analysis.

Custom Site Preference “Catalog Feed Configuration (geCatalogFeedConfig)“

The feed configuration is stored in site preference Catalog Feed Configuration(geCatalogFeedConfig) by path:

Merchant Tools > Site Preferences > Custom Site Preference Groups > Global‑e Catalog Jobs

Example of configuration:

{
	"impex": {
		"folderPath": "/globale/catalog/",
		"archiveFolderPath": "/globale/catalog/archive/"
	},
	"sftpCredentialIDs": [
		"Globale-SFTPCatalogFeedUpload"
	],
	"file": {
		"name": "globale_catalog_feed_{datetime}",
		"columns": [
			{
				"header": "Id (* mandatory field)",
				"type": "product",
				"attr": "ID"
			},
			{
				"header": "ParentProductID",
				"type": "product",
				"attr": "masterProduct.ID"
			},
			{
				"header": "HS Code (Commodity code)",
				"type": "product",
				"attr": "custom.hsCode",
				"fallback": {
					"type": "static",
					"attr": ""
				}
			},
			{
				"header": "Product Category",
				"type": "category",
				"attr": "displayName",
				"categoriesSeparator": ","
			},
			{
				"header": "DisplayName (*)",
				"type": "product",
				"attr": "name",
				"fallback": {
					"type": "product",
					"attr": "ID"
				}
			},
			{
				"header": "LongDescription(*)",
				"type": "product",
				"attr": "longDescription.markup"
			},
			{
				"header": "Height",
				"type": "product",
				"attr": "custom.geHeight",
				"fallback": {
					"type": "static",
					"attr": ""
				}
			},
			{
				"header": "Width",
				"type": "product",
				"attr": "custom.geWidth",
				"fallback": {
					"type": "static",
					"attr": ""
				}
			},
			{
				"header": "Length",
				"type": "product",
				"attr": "custom.geLength",
				"fallback": {
					"type": "static",
					"attr": ""
				}
			},
			{
				"header": "Volume",
				"type": "product",
				"attr": "custom.geVolume",
				"fallback": {
					"type": "static",
					"attr": ""
				}
			},
			{
				"header": "Weight (*)",
				"type": "weight",
				"attr": "custom.geWeight",
				"unit": "kg",
				"fallback": {
					"type": "static",
					"attr": ""
				}
			},
			{
				"header": "OriginCountry (ISO3) (*)",
				"type": "product",
				"attr": "custom.manufacturerCountryCode",
				"fallback": {
					"type": "static",
					"attr": ""
				}
			},
			{
				"header": "IsBlocked (*)",
				"type": "product",
				"attr": "custom.geIsBlocked",
				"fallback": {
					"type": "static",
					"attr": ""
				}
			},
			{
				"header": "IsVirtual",
				"type": "product",
				"attr": "custom.geIsVirtual",
				"fallback": {
					"type": "static",
					"attr": ""
				}
			},
			{
				"header": "VATRate",
				"type": "tax"
			},
			{
				"header": "Price",
				"type": "price",
				"attr": "gbp-sale-prices",
				"fallback": {
					"type": "product",
					"attr": "priceModel.price.value",
					"fallback": {
						"type": "static",
						"attr": "0"
					}
				}
			},
			{
				"header": "Keywords",
				"type": "static",
				"attr": ""
			},
			{
				"header": "Size",
				"type": "variationAttribute",
				"attr": "size",
				"value": "value"
			},
			{
				"header": "Color",
				"type": "variationAttribute",
				"attr": "color",
				"value": "value"
			},
			{
				"header": "ProductURL",
				"type": "productUrl",
				"attr": "pid",
				"controller": "Product-Show",
				"host": "www.example.com"
			},
			{
				"header": "ImageURL",
				"type": "imageUrl"
			}
		]
	},
	"feedData": {
		"localeId": "default",
		"catalogId": "storefront-catalog-m-non-en",
		"processOnlyModifiedProducts": true
	}
}

General details about fields of configuration

Details of the 'columns' field in configuration

Each column in the CSV file can be generated based on the system/custom attribute value of the product, Site Preference, system/custom attribute of the product category, price book, static (hardcoded), and more.

The following table provides additional details.

Only "price" and "product" types can be nested by any other type with using special "fallback" property, more than one time, like in the following example: Here we look for GBP price book, if not there look for product default price.

Nesting types to each other in Column JSON config

{
    "type": "price",
    "attr": "gbp-sale-prices",
    "fallback": {
        "type": "product",
        "attr": "priceModel.price.value",
        "fallback": {
            "type": "static",
            "attr": "0"
        }
    }
}

SFCC service credential configuration

The SFTP credentials provided by Global-e should be set in the SFCC service credential “Globale-SFTPCatalogFeedUpload“ (Administration > Operations > Services > Service Credentials > Globale-SFTPCatalogFeedUpload - Details):

Testing

This section describes the "GlobaleRestrictedItemsFeed" job, which is part of the default functionality of the Global-e SFCC cartridge.

As part of the integration process, Global‑e requires that you perform a periodic export of your product restrictions from SFCC to Global‑e.

The "GlobaleRestrictedItemsFeed" job generates a Restricted Items Feed and uploads it to an SFTP folder configured under Global‑e Site Preferences, from which Global‑e pulls the updated restricted items information.

The "GlobaleRestrictedItemsFeed" job picks up each product that has been modified or created since the last job run time and saves "" details to a CSV file. This CSV file is pushed to a pre-defined SFTP folder; this folder can be hosted by either, the merchant or Global‑e.

A different periodic service, hosted on the Global‑e servers, looks for the new export CSV file with restrictions details, and runs each new and updated restricted item through various classification processes.

Another SFCC job is scheduled to query the Global‑e API and returns the product classification and restriction information to SFCC.

The GlobaleRestrictedItemsFeed job is part of the standard functionality provided in the Global-e SFCC cartridge.

The restricted items feed has two components (Job steps): Generate Restricted Items Feed and Upload Restricted ItemsFeed.

Generate Restricted Items Feed	Upload Catalog Feed
This Job Step is responsible for generating the Restricted Items Feed in CSV format based on the parameters configured in the Global-e Site Preferences and for placing the result file into the SFCC IMPEX folder.	This Job Step is responsible for uploading the  Restricted Items Feed file placed in the SFCC IMPEX folder to the SFTP folder configured in the Global-e Site Preferences, so that Global-e can pull this file from that location and import it for further analysis.

In the "GlobaleRestrictedItemsFeed" job there are a few system objects definitions that are not assigned to any of the groups.