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.

API endpoint (POST request): GetShippingDocuments

https://{server_name}/Order/GetShippingDocuments?merchantGUID=abcdabcd

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.

PARAMETERS: Processing attributes

RESPONSE:

EXAMPLE: POST Request

UpdateOrderDispatchRequest

{
    "OrderId": "GE123874638GB",
    "HubCode": "hub001",
    "DeliveryReferenceNumber": "123756483",
    "Parcels": [
        {
            "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).

API ENDPOINT (POST request): DispatchOrders

https://{server_name}/Order/DispatchOrders?merchantGUID=abcdabcd

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.

PARAMETERS: Processing attributes

EXAMPLES

Request

{
    "OrderIds": [
        "GE11111111GB", "GE2222211GB"
    ],
    "HubCode": "hub001"
}

Response: OrderDocumentsResponse

{
    "IsSuccess": true,
    "ShipperManifests":
    [
        {
            "DocumentTypeCode": "3",
            "DocumentTypeName": "ShipperManifest",
            "DocumentExtension": "pdf",
            "URL": "https://assets.global-e.com/documents/04552836-ED8F-4362-AE09-FAB014DAA421.pdf",
            "DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G",
            "ErrorMessage": null
        },
        {
            "DocumentTypeCode": "3",
            "DocumentTypeName": "ShipperManifest",
            "DocumentExtension": "pdf",
            "URL": "https://assets.global-e.com/documents/8F0B8A31-B424-478D-AA72-1EB8BBDD7C27.pdf",
            "DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G"
        }
    ]
}

Once a label has been used to ship a set of goods, update the fulfilment 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
                }
            ]
        }
    ]
}