Dispatch Notifications (from Global‑e)

The Update Parcel Dispatch API pushes to the merchant Global-e updated Parcel Dispatch Information.

This notification will trigger when the prepared Orders/Parcels reach a status of “Dispatched to Customer” upon running the Carrier end-of-day manifest from the hub of dispatch (Global-e Hub or Merchant Hub depending on the logistics model).

API URL

POST https://www.merchant_site_domain.com/xxxxx

API Request Structure

Name			Required	Type	Description
DispatchedParcel			Yes	Object
	ParcelTracking		Yes	Object
		ParcelTrackingNumber	Yes		Tracking number used by the selected international shipping method for this parcel.
		ParcelTrackingUrl	Yes		Full tracking URL including ParcelTrackingNumber used by the selected international shipping method for this parcel.
		ParcelCode	Yes		Parcel code.
	HubCode				In the case of multi-hub dispatch, which mapped hub the order shipped from
	Code				Parcel Code
	StatusName			String	Parcel status name.
Products			Yes	Object List	List of products included in the parcel.
	SKU		Yes	String	SKU code is used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).
	CartItemId		Yes	String	Cart item id of the product.
	Quantity		Yes	Int64	Product quantity included in the parcel.
OrderId			Yes	String	Global‑e order unique identifier.
MerchantOrderId			No	String	Order unique identifier on the Merchant’s site returned from a previous call to the SendOrderToMerchant method for this order.
StatusCode				String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).
MerchantGUID			Yes	String	Unique identifier of the Merchant on Global-e.
WebStoreCode				String	Code used on the merchant’s site to identify the web store, as specified in the WebStoreCode argument for cart method for the cart converted to this order on Global‑e.
WebStoreInstanceCode				String	Refers to Merchant Store Instance.

API Response Structure

ResponseInfo

Parameter Name	Type	Description	Mandatory
Success	Boolean	Indicates if the API call has succeeded. True - Indicates that the call was successful. False - Denotes an error or failure.	Yes
Message	String	Success or Error code to be returned when an error occurs.	No
Description	String	Error Description	No

Parameter Name

Type

Description

Mandatory

Success

Boolean

Indicates if the API call has succeeded.

True - Indicates that the call was successful.

False - Denotes an error or failure.

Yes

Message

String

Success or Error code to be returned when an error occurs.

Description

String

Error Description

API Request Sample

{
    "UrlParameters": null,
    "DispatchedParcel": {
        "ParcelTracking": {
            "ParcelTrackingNumber": "0545123533352",
            "ParcelTrackingUrl": "https%3a%2f%2ftracking.dpd.de%2fstatus%2fen_NL%2fparcel%2f0545123533352",
            "ParcelCode": "24543282-P1"
        },
        "HubCode": null,
        "Code": "24543282-P1",
        "StatusName": null,
        "Products": [
            {
                "Sku": "00006901119001",
                "CartItemId": "e3480db5-f139-4f11-8111-fdb95353a110",
                "Quantity": 1
            }
        ]
    },
    "OrderId": "GE23457211382NL",
    "MerchantOrderId": "12456",
    "StatusCode": null,
    "MerchantGUID": "1d5111e18-31224-448d-ae3d-d11b1111991c",
    "WebStoreCode": "9o1eeefRR",
    "WebStoreInstanceCode": "GlobalEDefaultStoreInstance"
}

API Response Sample

Success example

{
    " Success ": "True ",
    "Message": "Fulfillment status was updated",
    "Description": null
}

Failure example

{
    " Success ": "False ",
    "Message": "error message",
    "Description": "error  description"
}

Documentation Portal