Documentation Portal

You can receive orders directly on your eCommerce platform or via 3^rd party integrations.

Accordingly, the following scenarios should be supported to associate orders with the Global‑e integration to generate shipping documentation:

Both methods should be implemented to comply with different merchant setups in pushing orders to the WMS/3PL.

Orders will arrive via the same channel as all other orders for a merchant. It’s important to map such orders and prevent them from being shipped via means other than Global‑e.

GetShippingDocuments

From the orders indicated as fulfilled with possible exceptions, the Global‑e API will return the required shipping documentation as a base64 encoded byte array and URL for printing

Example Request POST Request

UpdateOrderDispatchRequest

{
    "OrderId": "GE123874638GB",
    "HubCode": "hub001",
    "DeliveryReferenceNumber": "123756483",
    "Parcels": [
        {
            "ShippingAdditionalInformation":[
                {
                    "name":"ITNNumber",
                    "value":"X202487492387"
                }],
            "ParcelCode": "123454321",
            "Products": [
                {
                    "DeliveryQuantity": 1,
                    "ProductCode": "sku121212",
                },
                {
                    "DeliveryQuantity": 2,
                    "ProductCode": "sku131313"
                }
            ]
        }
    ]
}

Example Success Response:

OrderDocumentsResponse with List<OrderDocument> Documents

{
    "IsSuccess": true,
    "ErrorText": null,
    "Documents":
    [
        {
            "DocumentTypeCode": "4",
            "DocumentTypeName": "AWB",
            "DocumentExtension": "zpl",
            "URL": "https://assets.global-e.com/documents/478D-AA72-1EB8BBDD7C27.zpl",
            "DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G"
        },
        {
            "DocumentTypeCode": "1",
            "DocumentTypeName": "CommercialInvoiceAndPackingList",
            "DocumentExtension": "pdf",
            "URL": "https://assets.global-e.com/documents/AE09-FAB014DAA421.pdf",
            "DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G",
            "ErrorMessage": null
        }
    ],
    "ParcelsTracking": [
        {
            "ParcelTrackingNumber": "9895722141",
            "ParcelTrackingUrl": " https://mydhl.express.dhl/us/en/tracking.html#/results?id=9895722141",
            "ParcelCode": "123454321"
        }
    ]
}

ERROR RESPONSES

HTTP Error code as 500, 400 (or 200)

The response of the Get Shipping Documents API call (GSD) will include the tracking information of the shipment(s). Tracking information includes:

Tracking should always be stored from the ParcelsTracking array by matching the relevant parcel code tracking.

If the tracking is done on the order level, the tracking information of the order (Tracking Number and URL) will be populated on the parcel level as well (with the same values).

DispatchOrders

The DispatchOrders API provides the necessary carrier manifest, encoded as a base64 byte array, and a printing URL for all orders with printed labels since the last DispatchOrders call. Non-Shopify orders are tagged as Dispatched to Customer and set up to send tracking notification emails.

Once a label has been used to ship a set of goods, update the state back to the merchant platform to complete the workflow.

Single call

{
    "OrderId": "100018322",
    "Parcels": [
        {
            "ParcelCode": "100018322-1",
            "Products": [
                {
                    "ProductCode": "product-A",
                    "DeliveryQuantity": 1
                },
                {
                    "ProductCode": "product-B",
                    "DeliveryQuantity": 2
                }
            ]
        }
    ]
}

Single call

{
     "OrderId": "100018322",
     "Parcels": [
        {
             "ParcelCode": "100018322-1",
             "Products": [
                {
                    "ProductCode": "product-A",
                    "DeliveryQuantity": 1
                }
             ]
         },
        {
             "ParcelCode": "100018322-2",
             "Products": [
                {
                    "ProductCode": "product-B",
                    "DeliveryQuantity": 2
                }
             ]
         }
     ]
 }

First call (“day 1”)

{
    "OrderId": "100018322",
    "Parcels": [
        {
            "ParcelCode": "100018322-1",
            "Products": [
                {
                    "ProductCode": "product-A",
                    "DeliveryQuantity": 1
                },
                {
                    "ProductCode": "product-B",
                    "DeliveryQuantity": 1
                }
            ]
        }
    ]
}

Subsequent call (“day 2”)

{
    "OrderId": "100018322",
    "Parcels": [
        {
            "ParcelCode": "100018322-2",
            "Products": [
                {
                    "ProductCode": "product-B",
                    "DeliveryQuantity": 1
                }
            ]
        }
    ]
}

The Void Parcel API lets you take out a declared parcel if you do not intend to send it or if it needs to be updated due to changed shipment requirements.

At least one order ID should be provided in the request, Global-e OrderId or the merchant's MerchantOrderId.

A new developer shop should be created and connected to your software or warehouse management system.

You must place an order via standard checkout and not a draft order, created through Shopify Admin.