UpdateOrderDispatchV2

Updates the order status and Delivery Quantities for the products, as well as the Merchant’s internal Delivery Reference Number, if applicable. You can also add tracking information on each parcel or on the entire order. Optionally, you can include the list of Parcels with Products for this order shipment to the Global-e hub, exceptions to report on out-of-stock items, and items that will be shipped later on.

Method/URL

https://{server_name}/Order/UpdateOrderDispatchV2

Parameters

Request

Name	Type	Description	Mandatory
`request`	Object UpdateOrderDispatchRequest	Full post data including `OrderId`, Exceptions, and Parcels with Products for the call. Note: `OrderId` attribute can accept the value of an `OrderID` (unique order identifier) or `MerchantOrderId` (unique merchant order identifier).

Name

Type

Description

Mandatory

request

Object UpdateOrderDispatchRequest

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

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

UpdateOrderDispatchRequest

Parameter Name	Type	Description	Mandatory
`DeliveryReferenceNumber`	String	Merchant’s internal Delivery Reference Number for this order.	No
`Exceptions`	List of `UpdateOrderDispatchException`	List of `UpdateOrderDispatchException` objects for this the `UpdateOrderDispatchRequest`. Note Either Parcels or Exceptions should be specified.	Mandatory if the `Parcels` property is not specified.
`HubCode`	String	Merchant hub code that indicates which hub the parcels are being sent from. Note The `hubCode` should be mapped to a Global‑e hubId on the Global‑e side.	No
`IsCompleted`	Boolean	Flag to mark orders as “completed” by the Merchant. TRUE if order fulfillment has been completed and no more products will be shipped. FALSE if order fulfillment has not been completed yet.
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site. Note Either `OrderID` or `MerchantOrderID` should be specified.	Mandatory if the `OrderID` property is not specified.
`OrderId`	String	Global‑e order unique identifier. Note Either `OrderID` or `MerchantOrderID` should be specified.	Mandatory if the `MerchantOrderID` property is not specified.
`Parcels`	List of `Parcel`	List of Parcel objects for this `UpdateOrderDispatchRequest`. Note Either Parcels or Exceptions should be specified.	Mandatory only if the `Exceptions` property is not specified.
`ShippingAdditionalInformation`	String	Used if additional information is required for shipment. Currently, it is used for the ITN number when exporting from the US.	No
`ShippingMethodCode`	String	Shipping Method Code used for the order instead of the original one. The order should use WYOL and the input shipping method also be WYOL. NOTE: The Shipping Method Code should be mapped to a Global‑e Shipping Method on the Global‑e side.	No
`TrackingDetails`	Object `TrackingDetails`	Tracking information at the order level of the parcel in case the Merchant does the shipping by itself.	No

Parcel

Parameter Name	Type	Description	Mandatory
`Height`	Decimal	Parcel height in centimeters/inches as measured by the Merchant.	No
`Length`	Decimal	Parcel length in centimeters/inches as measured by the Merchant.	No
`ParcelCode`	String	Code used to identify the Parcel on the Merchant’s site
`Products`	List of `Product`	List of products contained in the parcel (for each Product object the following fields are relevant when used in the Parcel class: `ProductCode`, `CartItemId`, `DeliveryQuantity`). The products list is applicable only when including the list of products in each parcel is mandatory (such as in the `UpdateParcelDispatch` method).	No
`TrackingDetails`	Object `TrackingDetails`	Tracking information about the order/parcel.	No
`Weight`	Decimal	Parcel weight in grams as measured by the Merchant.	No
`Width`	Decimal	Parcel width in grams as measured by the Merchant.	No

Product

Parameter Name	Type	Description	Mandatory
`Attributes`	List of `Attributes`	The product’s custom attributes (such as Color, Size, etc.)	No
`AttributesEnglish`	List of `Attributes`	The product’s custom attributes (such as Color, Size, etc.) in English	No
`BackOrderDate`	String	Estimated date for the backordered item to be in stock	No
`Brand`	Object `Brand`	The product’s brand	No
`CartItemId`	String	Identifier of the cart item on the Merchant’s site. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	No
`CartItemOptionId`	String	Identifier of the child cart item “option” on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (`CartItemId` must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a package for the parent item in the same cart. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	No
`Categories`	List of `Category`	The product’s categories	No
`DeliveryQuantity`	Decimal	The quantity actually set for delivery for the product (to be used in the Order methods described below, as needed)	No
`Description`	String	Description of the Product
`DescriptionEnglish`	String	Description of the Product in English
`GenericHSCode`	String	The product’s generic HS Code (not country-specific). If specified this property may assist in mapping the product for duties and taxes calculation purposes.	No
`GiftMessage`	String	Optional “gift message” text defined by the end customer to be printed on the product.	No
`HandlingCode`	String	Code applicable to the product on the Merchant’s site. This code may be optionally used by the Merchant to trigger a certain business logic when this product is included in the order posted back to the Merchant’s site with the `SendOrderToMerchant` method.	No
`Height`	Decimal	The product’s height in the Merchant’s default unit of length measure (will be converted to CM).	No
`HubCode`	String	The Merchant hub code indicates from which hub the product was sent. Note that the HubCode should be mapped to a Global-e hubId on the Global-e side.	No
`ImageHeight`	Decimal	The product’s image height in pixels	No
`ImageURL`	String	The product’s image URL	No
`ImageWidth`	Decimal	The product’s image width in pixels
`IsBackOrdered`	Boolean	Boolean specifying if the product was ordered as a backed ordered item. TRUE - The item is back ordered FALSE - The item is not back ordered. Default FALSE.	No
`IsBlockedForGlobalE`	Boolean	Indicates if product is available for international shipping. TRUE - The product is not available for international shipping FALSE - The product is available for international shipping	No
`IsBundle`	Boolean	Indicates if the product represents a set of products. TRUE - The product represents a set of other products. If a bundled product has non-zero prices specified (i.e. `OriginalListPrice`, `ListPrice`, etc.), then all the contained products must have zero prices, and vice versa, to avoid double charging for the same products. FALSE - The product does not represent a set of other products.	No
`IsFixedPrice`	Boolean	Indicates if the product’s price is fixed by the Merchant, in the default currency for the country. TRUE - The product’s price is fixed. In this case, all price modifications are disabled for this product. Setting fixed prices is only allowed for the Countries where the `SupportsFixedPrices` flag is set to TRUE. FALSE - The product's price is not fixed.	No
`IsVirtual`	Boolean	Indicates if the product represents a virtual product that does not have weight or volume and doesn’t affect shipping calculation in Global‑e checkout TRUE - The product represents a virtual product FALSE - The product does not represent a virtual product	No
`Keywords`	String	The product’s keywords	No
`Length`	Decimal	The product’s length in the Merchant’s default unit of length measure (will be converted to CM).	No
`LineItemOriginalSalePrice`	Decimal	Line item (product in ordered quantity) sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the price in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country. If not specified, will be deemed equal to “`OriginalSalePrice* OrderedQuantity`”. If specified, will take preference over `OriginalSalePrice`.	No
`LineItemSalePrice`	Decimal	Line item (product in ordered quantity) sale price as displayed to the customer, after applying country coefficient, FX conversion and `IncludeVAT` handling, before rounding rules have been applied. If not specified, will be deemed equal to “`SalePrice * OrderedQuantity`”. If specified, will take preference over `SalePrice`.	No
`ListPrice`	Decimal	Product list price (before discounts) as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable) and `IncludeVAT` handling.	Optional in `SendCart`, `SaveProductsBulk`
`LocalVATRateType`	Object `VATRateType`	VAT rate type or class that would be applied to this product if the order was placed by the local customer. This value must be specified if `UseCountryVAT` for the current Country is TRUE, and therefore the `VATRateType` property actually denotes the VAT for the target country.	No
`MetaData`	Object `ProductMetaData`	Used to hold additional product data such as customer-defined product attributes.	No
`Name`	String	Name of the Product
`NameEnglish`	String	Name of the Product in English
`NetVolume`	Decimal	The product’s net volume in the Merchant’s default unit of volume measure (will be converted to cubic CM). If specified, this property indicates the net volume of the product, excluding any packaging.	No
`NetWeight`	Decimal	The product’s net weight in the Merchant’s default unit of weight measure (will be converted to grams). If specified, this property indicates the net weight of the product, excluding any packaging.	No
`OrderedQuantity`	Decimal	Ordered quantity for the product (to be used in Checkout / Order methods described below, as needed)	No
`OriginalListPrice`	Decimal	Product list price (before any discounts) in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country.	Optional in `SendCart`, `SaveProductsBulk`
`OriginalSalePrice`	Decimal	Product sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country.	Optional in SaveProductsList, `SaveProductsBulk`
`OriginCountryCode`	String	2-char ISO country code of the product’s country of Origin. The Merchant’s country will be assumed if not specified.	No
`ParentCartItemId`	String	Identifier of the current item’s parent cart item on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (`CartItemId` must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a custom option (such as a product package) for the parent item in the same cart. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	No
`PriceCoefficientRate`	Decimal	Rate applicable to this Product’s`ProductClassCode` if returned from the `CountryCoefficients` method.	No
`ProductClassCode`	String	The product class code is used by the Merchant to classify products to use different country coefficient rates.	No
`ProductCode`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side)
`ProductCodeSecondary`	String	Secondary code that may be used to refer to the product on the Merchant’s site. This code may be used in addition to the `ProductCode` and is not guaranteed to be unique (may be reused for other products as long as the old product is not available on the Merchant’s site any more).	No
`ProductGroupCode`	String	Product’s group code on the Merchant’s site (to be mapped on the Global‑e side). Usually, this value is a part of the product SKU code denoting a group of similar products (such as "the same product in different s").	No
`ProductGroupCodeSecondary`	String	Secondary code that may refer to the group of products on the Merchant’s site. This code may be used in addition to the `ProductGroupCode` and is not guaranteed to be unique (may be reused for other groups as long as the old group is not available on the Merchant’s site anymore).	No
`SalePrice`	Decimal	Product sale price as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable) and `IncludeVAT` handling.	Optional in SaveProductsList, `SaveProductsBulk`, GetCheckoutCartInfo
`SalePriceBeforeRounding`	Decimal	Product sale price as displayed to the customer, after applying country coefficient, FX conversion and `IncludeVAT` handling, before rounding rules have been applied. If not specified, will be deemed equal to `SalePrice`.	No
`SalePriceReason`	String	Reason for the sale price. This property may optionally contain the text definition of the promo that has resulted in the price deduction for this product (such as “10% discount on all shoes”).	No
`URL`	String	The product’s information page URL	No
`VATCategory`	Object `VATCategory`	The product’s VAT category. A product may be assigned to a single VAT category on the Merchant’s site. If available, the respective product’s HS Code should be used as the VAT category for a product.	No
`VATRateType`	Object `VATRateType`	Product’s VAT rate type or class	No
`Volume`	Decimal	The product’s volume in the Merchant’s default unit of volume measure (will be converted to cubic CM).	Optional, can be used as an alternative for specifying all Height, Width and Length dimensions
`Weight`	Decimal	The product’s weight is in the Merchant’s default unit of weight measure (will be converted to grams). The Merchant’s default product weight will be used if not specified.	No
`Width`	Decimal	The product’s width in the Merchant’s default unit of length measure (will be converted to CM).	No

Attributes

Parameter Name	Type	Description
`AttributeCode`	String	Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)
`AttributeTypeCode`	String	Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for "colour", etc. (to be mapped on the Global‑e side)
`Name`	String	Attribute name

Parameter Name	Type	Description	Mandatory
`BrandCode`	String	Brand code on the Merchant’s site (to be mapped on the Global‑e side)
`Name`	String	Brand name

Parameter Name	Type	Description	Mandatory
`CategoryCode`	String	Category code on the Merchant site (to be mapped on the Global‑e side)
`Name`	String	Category name

MetaData

Parameter Name	Type	Description	Mandatory
`Attributes`	List of `Attributes`	Customer-defined product attributes that allow the personalisation of the product if supported by the merchant’s site (e.g. engraving)

Attributes

Parameter Name	Type	Description
`AttributeCode`	String	Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)
`AttributeTypeCode`	String	Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for "colour", etc. (to be mapped on the Global‑e side)
`Name`	String	Attribute name

VATCategory

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT Category name
`VATCategoryCode`	String	Code used to identify the VAT category on the Merchant’s site (to be mapped on the Global‑e side)

VATRateType

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT rate type name	No
`Rate`	Decimal	VAT rate decimal value
`VATRateTypeCode`	String	VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)

Parameter Name	Type	Description	Mandatory
`TrackingNumber`	String	The tracking number as the shipper has specified

Parameter Name	Type	Description	Mandatory
`TrackingNumber`	String	The tracking number as the shipper has specified

UpdateOrderDispatchException

Parameter Name	Type	Description	Mandatory
`CartItemId`	String	Identifier of the cart item on the Merchant’s site. This property may be optionally specified in the `SendCart` method only so that the same value could be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method. Either `CartItemId` or `ProductCode` should be specified.	Mandatory only if the `ProductCode` property was not specified.
`ExceptionType`	Decimal	One of the following possible values of the `ExceptionTypes` enumeration: 1 - Out Of Stock: Out-of-stock items will not be fulfilled 2 - Backorder Preorder Customized Item: Backorder/preorder/customized items will be fulfilled. 3 - Cancellation by request: Cancelled by customer request will not be fulfilled.
`ExpectedFulfilmentDate`	Date	Expected date for backordered/preordered/customized item to be fulfilled (in YYYY-MM-DD format).	No
`ProductCode`	String	Product unique identifier on the Merchant’s site. Either `CartItemId` or `ProductCode` should be specified.	Mandatory only if the `CartItemId` property was not specified.
`Quantity`	Decimal	Product quantity that the exception refers to.	Mandatory only for Exception Type 3.

Response

Name	Type	Description	Mandatory
`ResponseInfo`	Object ResponseInfo	Indicates if the API call was successfull.

ResponseInfo

Parameter Name	Type	Description	Mandatory
`Success`	Boolean	Indicates if the call was successful. Success property value may be only TRUE. Otherwise, ErrorInfo will be returned instead. TRUE - Call was successful FALSE - Call failed For more information see `ErrorInfo`.
`Reason`	String	Text that optionally describes the reason for Success status.

Parameter Name

Type

Description

Mandatory

Success

Boolean

Indicates if the call was successful. Success property value may be only TRUE. Otherwise, ErrorInfo will be returned instead.

TRUE - Call was successful

FALSE - Call failed

For more information see ErrorInfo.

Reason

String

Text that optionally describes the reason for Success status.

Parameter Name	Type	Description
`Code`	String	The error code
`error`	String	The error message
`Description`	String	The error description

Examples

Request

{
    "OrderId": "GE123874638GB", //Can accept either OrderID or MerchantOrderID
    "MerchantOrderID": "100018322",
    "DeliveryReferenceNumber": "123756483",
    "IsCompleted": false,
    "Parcels": [{
            "ParcelCode": "123454321",
            "Products": [{
                    "DeliveryQuantity": 1,
                    "CartItemId": "12365",
                    "ProductCode": "121212"
                }, {
                    "DeliveryQuantity": 2,
                    "CartItemId": "12376",
                    "ProductCode": "131313"
                }
            ],
            "TrackingDetails": {
                "TrackingNumber": "111111122666"
            }
        }
    ],
    "Exceptions": [{
            "CartItemId": "12366",
            "ProductCode": "121213",
            "ExceptionType": 1
        }, {
            "CartItemId": "12367",
            "SKU": "SKU121214",
            "ExceptionType": 2,
            "ExpectedFulfilmentDate": "2018-01-18"
        }
    ],
    "TrackingDetails": {
        "TrackingNumber": "111111122666"
    }
}

Documentation Portal

UpdateOrderDispatchV2

Parameters

UpdateOrderDispatchRequest

Parcel

Product

Attributes

Brand

Category

MetaData

Attributes

VATCategory

VATRateType

TrackingDetails

TrackingDetails

UpdateOrderDispatchException

ResponseInfo

ErrorInfo

Examples

Search results