Skip to main content

Documentation Portal

GetShippingDocuments

Returns the existing shipping documents for the requested order, and also shipping documents and parcels for the orders specified in the request.

Usage

There are two usages:

  1. The request is issued with an empty list of parcels, and/or exceptions (no hubCode is provided). Here all the existing shipping documents for the requested order are returned.

  2. The request includes a list of parcels for the OrderId  / MerchantOrderId, and/or the list of exceptions. It returns:

    - Updates to order status and Delivery Quantities for the products and Merchant’s internal Delivery Reference Number if applicable. Optionally, it can include Exceptions to report on out-of-stock items and items that will be shipped later on. In addition, there is an option to add tracking information on each parcel or for the entire order.

    - Update the status of orders and parcels received in the Hub. If the optional hubCode is provided, assign the specified parcels for the specified hub. The feature is used when an order includes parcels to be sent from different hubs.

    Optional: You can add information to be used later when the shipping request is placed to FedEx. This is implemented by adding the ShippingAdditionalInformation property in the order level or the parcel level (not both).

    When the shipping is handled by 3PL, depending on the merchant configuration, the GELabel may be set to 4, to print a Global-e label at the hub.

URL

https://{server_name}/Order/GetShippingDocuments
Parameters

Request

Name

Type

Description

Mandatory (Y/N)

request

Object UpdateOrderDispatchRequest

Full post data including OrderId, Exceptions, and Parcels with Products.

Note: OrderId attribute can accept the value of an OrderID (unique order identifier) or MerchantOrderId (unique merchant order identifier).

Y

Response

Name

Type

Description

OrderDocumentResponse

Object OrderDocumentsResponse

Receive object OrderDocumentsResponse.

Examples

Request

Sample request for the first usage with an empty list of parcels and empty list of exceptions, returning all the existing shipping documents for the requested order

{
    "OrderId": "GE123874638GB",  
    "MerchantOrderID": "100018322",
    "DeliveryReferenceNumber": "123756483",
    "IsCompleted": true,
    "Parcels": [],
    "Exceptions": []
}

Sample request for the second usage with a list of parcels and exceptions, which updates the order status

{
    "HubCode": "Store",
    "OrderId": "GE123874638GB",
    "MerchantOrderID": "100018322",
    "DeliveryReferenceNumber": "123756483",
    "IsCompleted": true,
    "Parcels": [{
            "ParcelCode": "123454321",
            "Products": [{
                    "DeliveryQuantity": 1,
                    "CartItemId": "12365",
                    "ProductCode": "121212"
                }, {
                    "DeliveryQuantity": 2,
                    "CartItemId": "12376",
                    "ProductCode": "131313"
                }
            ],
            "TrackingDetails": {
                "TrackingNumber": "111111122666"
            },
/*Add ShippingAdditionalInformation at the order level or at the package level, not both.*/
            "ShippingAdditionalInformation": [{
                    "name": "ITNNumber",
                    "value": "12345"
                }
            ]
        }
    ],
    "Exceptions": [{
            "CartItemId": "12366",
            "ProductCode": "121213",
            "ExceptionType": 1
        }, {
            "CartItemId": "12367",
            "SKU": "SKU121214",
            "ExceptionType": 2,
            "ExpectedFulfilmentDate": "2018-01-18"
        }
    ],
    "TrackingDetails": {
        "TrackingNumber": "111111122666"
    },
/*Add ShippingAdditionalInformation at the order level or at the package level, not both.*/
    "ShippingAdditionalInformation": [{
            "name": "ITNNumber",
            "value": "12345"
        }
    ]
}