Documentation Portal

UpdateParcelDispatch (UpdateParcelDispatchRequest request)

Marks the relevant parcels within a specific order as dispatched from the merchant to the Global‑e hub and updates Delivery Quantities for the products included in each parcel.

SAMPLE

Body:

{
    "OrderId": "GE123456789GB",
    "Parcels": [{
            "ParcelCode": "abc-1234",
            "Products": [{
                    "CartItemId": "123544",
                    "ProductCode": "123467",
                    "DeliveryQuantity": 1
                }, {
                    "CartItemId": "123545",
                    "ProductCode": "123468",
                    "DeliveryQuantity": 0
                }
            ]
        }, {
            "ParcelCode": "abc-1235",
            "Products": [{
                    "CartItemId": "123554",
                    "ProductCode": "123487",
                    "DeliveryQuantity": 2
                }, {
                    "CartItemId": "123545",
                    "ProductCode": "123468",
                    "DeliveryQuantity": 3
                }
            ]
        }
    ]
}

URL:

https://{server_name}/Parcel/UpdateParcelDispatch?merchantGUID=abcdabcd-abcd-abcd-abcd-abcdabcdabcd

ACCEPTS

UpdateParcelDispatchRequest request

Full post data including the OrderId and Parcels for the call

RETURNS

ResponseInfo class

Overview 

The update status request is issued by the merchant to notify of a parcel’s status change. The notification is received by Global-e and handled asynchronously until the new parcel status is successfully updated. In case of a failure to update, the merchant will not be asked to retry.

For example, if the status update to the new status requested by the merchant is not allowed, or if the parcel has not yet been created, then manual intervention by Global-e will be required.

Prerequisites 

When using this call for the Buy-Online-Pick-In-Store (BOPIS) procedure, the UpdateParcelStatus call is initiated by the merchant following the issue of the UpdateOrderDispatchV2 call.

Implementation 

API Endpoint URL:

[POST] https://{server_name}/orders/{orderId}/parcels/{parcelCode}/statuses

Parameters 

Request Path Parameters 

Request Body Parameters 

Returns 

ResponseInfo class

Example: 

[POST] https://{server_name}/orders/GE1235436GB/parcels/4666593812/statuses

Request 

{
	"merchantParcelStatusCode": "Delivered"
}

Response 

{
  "success":true
}  

Error Codes 

VoidParcel  (VoidParcelRequest request)

Voids the relevant parcel within a specific order. The corresponding parcel in the order sends cancelling shipment requests and sets the parcel as inactive in the Global-e system.

SAMPLE

Body:

{
    "OrderId": "GE176045689GB",
    "ParcelCode": "P3"
    "MerchantOrderId": "#1138"
}

URL:

https://{server_name}/Parcel/VoidParcel?merchantGUID=abcdabcd-abcd-abcd-abcd-abcdabcdabcd

ACCEPTS

VoidParcelRequestrequest

Full post data including OrderId/MerchantOrderId/DeliveryReferenceNumber and Parcel for the call

RETURNS

VoidParcelResponse class