Skip to main content
POST
RemoveRestrictedProducts (Global-e to Merchant)
This API is part of Global-e’s extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required.
This API removes restricted products from the merchant cart; it notifies merchants that restricted products were removed from the cart, then merchants must also update the cart on the merchant side.

Body

application/json

Contains information related to a request to remove a restricted product.

CartId
string

Identifier of the cart on the Merchant’s site originally specified in merchantCartToken argument for SendCart method for the cart converted to this order on Global‑e.

CartToken
string

The value returned from the previous call to SendCart for the same client (must be stored in the client session or persistent cookie on the Merchant’s side). This parameter is used to support cart updates.

CountryCode
string

2-char ISO country code

CurrencyCode
string

3-char ISO currency code.

MerchantGUID
string

Unique identifier of the Merchant on Global-e.

RemovedProductCodes
string[]

List of SKU codes for products removal from the cart.

UserId
string | null

Internal User identifier on the Merchant’s site in case it was specified in the SendCart call.

WebStoreCode
string | null

Code used on the Merchant’s side to identify the web store where the current cart is originating from. This code should be used in case of a multi-store setup on the Merchant’s site.

WebStoreInstanceCode
string | null

Code used on the Merchant’s side to identify the web store instance where the current cart is originating from. This code should be used in case of multi-store domains set up on the Merchant’s site.

Response

200 - application/json

Provides details about response to API call for removal of a restricted product.

Provides details about response to API call for removal of a restricted product.

ErrorCode
string

Code of the error if it happened

ErrorMessage
string

Description of the error if it happened

IsSuccess
boolean

Indicates if the result is success. TRUE - Restricted product removal successful. FALSE - Restricted product removal not successful.