Update Order Shipping Info (Global-e to Merchant)

UpdateOrderShippingInfo (Global-e to Merchant)

curl --request POST \
  --url https://{merchant_site_domain}/order-shipping-info-update-only-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "OrderId": "00010000100000000020",
  "InternationalDetails": {
    "OrderTrackingNumber": "1265443",
    " OrderTrackingUrl": "https://www.somecarrier.com/?1265443"
  },
  "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd"
}
'

import requests

url = "https://{merchant_site_domain}/order-shipping-info-update-only-url"

payload = {
    "OrderId": "00010000100000000020",
    "InternationalDetails": {
        "OrderTrackingNumber": "1265443",
        " OrderTrackingUrl": "https://www.somecarrier.com/?1265443"
    },
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    OrderId: '00010000100000000020',
    InternationalDetails: {
      OrderTrackingNumber: '1265443',
      ' OrderTrackingUrl': 'https://www.somecarrier.com/?1265443'
    },
    MerchantGUID: 'abcdabcd-abcd-abcd-abcd-abcdabcdabcd'
  })
};

fetch('https://{merchant_site_domain}/order-shipping-info-update-only-url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{merchant_site_domain}/order-shipping-info-update-only-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'OrderId' => '00010000100000000020',
    'InternationalDetails' => [
        'OrderTrackingNumber' => '1265443',
        ' OrderTrackingUrl' => 'https://www.somecarrier.com/?1265443'
    ],
    'MerchantGUID' => 'abcdabcd-abcd-abcd-abcd-abcdabcdabcd'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{merchant_site_domain}/order-shipping-info-update-only-url"

	payload := strings.NewReader("{\n  \"OrderId\": \"00010000100000000020\",\n  \"InternationalDetails\": {\n    \"OrderTrackingNumber\": \"1265443\",\n    \" OrderTrackingUrl\": \"https://www.somecarrier.com/?1265443\"\n  },\n  \"MerchantGUID\": \"abcdabcd-abcd-abcd-abcd-abcdabcdabcd\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{merchant_site_domain}/order-shipping-info-update-only-url")
  .header("Content-Type", "application/json")
  .body("{\n  \"OrderId\": \"00010000100000000020\",\n  \"InternationalDetails\": {\n    \"OrderTrackingNumber\": \"1265443\",\n    \" OrderTrackingUrl\": \"https://www.somecarrier.com/?1265443\"\n  },\n  \"MerchantGUID\": \"abcdabcd-abcd-abcd-abcd-abcdabcdabcd\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{merchant_site_domain}/order-shipping-info-update-only-url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"OrderId\": \"00010000100000000020\",\n  \"InternationalDetails\": {\n    \"OrderTrackingNumber\": \"1265443\",\n    \" OrderTrackingUrl\": \"https://www.somecarrier.com/?1265443\"\n  },\n  \"MerchantGUID\": \"abcdabcd-abcd-abcd-abcd-abcdabcdabcd\"\n}"

response = http.request(request)
puts response.read_body

{
  "Description": "<string>",
  "ErrorCode": "<string>",
  "InternalOrderId": "<string>",
  "Message": "<string>",
  "OrderId": "<string>",
  "PaymentAmount": "<string>",
  "PaymentCurrencyCode": "<string>",
  "StatusCode": "<string>",
  "Success": true
}

POST

order-shipping-info-update-only-url

UpdateOrderShippingInfo (Global-e to Merchant)

curl --request POST \
  --url https://{merchant_site_domain}/order-shipping-info-update-only-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "OrderId": "00010000100000000020",
  "InternationalDetails": {
    "OrderTrackingNumber": "1265443",
    " OrderTrackingUrl": "https://www.somecarrier.com/?1265443"
  },
  "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd"
}
'

import requests

url = "https://{merchant_site_domain}/order-shipping-info-update-only-url"

payload = {
    "OrderId": "00010000100000000020",
    "InternationalDetails": {
        "OrderTrackingNumber": "1265443",
        " OrderTrackingUrl": "https://www.somecarrier.com/?1265443"
    },
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    OrderId: '00010000100000000020',
    InternationalDetails: {
      OrderTrackingNumber: '1265443',
      ' OrderTrackingUrl': 'https://www.somecarrier.com/?1265443'
    },
    MerchantGUID: 'abcdabcd-abcd-abcd-abcd-abcdabcdabcd'
  })
};

fetch('https://{merchant_site_domain}/order-shipping-info-update-only-url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{merchant_site_domain}/order-shipping-info-update-only-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'OrderId' => '00010000100000000020',
    'InternationalDetails' => [
        'OrderTrackingNumber' => '1265443',
        ' OrderTrackingUrl' => 'https://www.somecarrier.com/?1265443'
    ],
    'MerchantGUID' => 'abcdabcd-abcd-abcd-abcd-abcdabcdabcd'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{merchant_site_domain}/order-shipping-info-update-only-url"

	payload := strings.NewReader("{\n  \"OrderId\": \"00010000100000000020\",\n  \"InternationalDetails\": {\n    \"OrderTrackingNumber\": \"1265443\",\n    \" OrderTrackingUrl\": \"https://www.somecarrier.com/?1265443\"\n  },\n  \"MerchantGUID\": \"abcdabcd-abcd-abcd-abcd-abcdabcdabcd\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{merchant_site_domain}/order-shipping-info-update-only-url")
  .header("Content-Type", "application/json")
  .body("{\n  \"OrderId\": \"00010000100000000020\",\n  \"InternationalDetails\": {\n    \"OrderTrackingNumber\": \"1265443\",\n    \" OrderTrackingUrl\": \"https://www.somecarrier.com/?1265443\"\n  },\n  \"MerchantGUID\": \"abcdabcd-abcd-abcd-abcd-abcdabcdabcd\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{merchant_site_domain}/order-shipping-info-update-only-url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"OrderId\": \"00010000100000000020\",\n  \"InternationalDetails\": {\n    \"OrderTrackingNumber\": \"1265443\",\n    \" OrderTrackingUrl\": \"https://www.somecarrier.com/?1265443\"\n  },\n  \"MerchantGUID\": \"abcdabcd-abcd-abcd-abcd-abcdabcdabcd\"\n}"

response = http.request(request)
puts response.read_body

{
  "Description": "<string>",
  "ErrorCode": "<string>",
  "InternalOrderId": "<string>",
  "Message": "<string>",
  "OrderId": "<string>",
  "PaymentAmount": "<string>",
  "PaymentCurrencyCode": "<string>",
  "StatusCode": "<string>",
  "Success": true
}

Body

application/json

Object MerchantOrder contains details about the status of the order on the merchant's site.

InternationalDetails

object

required

Details referring to the end customer’s order placed on the Global‑e side. These details apply only to the Merchants dealing with international customers’ support themselves.

Show child attributes

OrderId

string

required

Global‑e order unique identifier.

AdditionalRequiredDocuments

any[]

The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.

AllowMailsFromMerchant

boolean

Indicates if the end customer has opted on the Global‑e checkout page to receive emails from the Merchant. TRUE - Customer opted to receive emails FALSE - Customer did not opt to receive emails

CartHash

string

Cart hash originally specified in the merchantCartHash argument for the SendCart method for the cart converted to this order on Global‑e.

CartId

string

Identifier of the cart on the Merchant’s site originally specified in merchantCartToken argument for SendCart method for the cart converted to this order on Global‑e.

CashOnDeliveryFee

number

Cash On Delivery fee amount in Merchant’s currency.

CCFPrice

number

Customs Clearance Fees (CCF), in the Merchant currency.

ClearCart

boolean

Indicates if the end customer’s cart must be cleared before this method finishes execution on the Merchant’s site. TRUE - The end customer’s cart must be cleared FALSE - The end customer's cart does not have to be cleare

CurrencyCode

string

3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency.

CurrencyName

string

Customer currency name.

Customer

object

The paying customer’s preferences (Global-e acts as a paying customer).

CustomerComments

string

Holds the gift message. In the offline order flow, holds the product comment.

CustomerDTBreakdown

object

Contains the duties and tax parts the customer paid for the order.

DateCreated

string

Order creation date and time.

DiscountedShippingPrice

number

The shipping price paid by the customer converted to the Merchant’s currency. Total Shipping price reducing Order Discounts (InternationalDetails.DiscountedShippingPrice price converted to the Merchant currency).

Discounts

any[]

The list of discounts being applied to the order, according to the original list of discounts received in SendCart for this order, and to the Merchant shipping configuration on Global‑e.

DoNotChargeVAT

boolean

Indicates if the end customer hasn’t been charged VAT in Global‑e checkout, as specified in the doNotChargeVAT argument for the SendCart method for the cart converted to this order on Global‑e. TRUE - VAT is not charged TRUE - VAT is charged

ExporterDetails

object

Show child attributes

FreeShippingCouponCode

string

Merchant’s free shipping CouponCode applied by the end customer, as specified in the FreeShippingCouponCode argument for the SendCart method for the cart converted to this order on Global‑e.

IsB2B

boolean

Indicates if the order has a Company name and VAT registration number. TRUE - Order contains a company name and VAT registration number FALSE - Order does not contain a company name and VAT registration number

IsFreeShipping

boolean

Indicates if the Merchant offers free international shipping to the end customer, as specified in the IsFreeShipping argument for the SendCart method for the cart converted to this order on Global‑e. TRUE - Shipping is free. FALSE - Shipping is not free.

IsMoto

boolean

Indicates if the the customer is a customer support agent and an “Offline order” took place TRUE - The customer is a customer support agent and an “Offline order” took place FALSE - The customer is a regular customer

IsReplacementOrder

boolean

Indicates if the order is a replacement. TRUE - The order is a replacement FALSE - The order is not a replacement

IsSplitOrder

boolean

Indicates if the order should be handled as a split order (i.e. without consolidation). TRUE - Order will be split FALSE - Order is not to be split

IsTaxExemption

boolean

Indicates if the order has a tax exemption. TRUE - Order has a tax exemption FALSE - Order does not have a tax exemption

LoyaltyCode

string

Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout.

LoyaltyPointsEarned

number

The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in the loyaltyPointsEarned argument for the SendCart method for the cart converted to this order on Global-e.

LoyaltyPointsSpent

number

The number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, the “Loyalty points” type discount must not be applied to the order directly but can be used for display purposes elsewhere in the system (i.e. on the end user’s My Account page).

Markups

any[]

The list of markups being applied to the order, according to the Merchant shipping configuration on Global‑e. Effectively Markup is a “negative Discount”. The main use case for markups is when the end customer is charged in Global‑e checkout, a flat shipping rate, which is higher than the shipping rate, calculated for the respective order. In this case, Global‑e pays the difference to the Merchant in the form of Markups applied to the order. Unlike Discounts, Markups may be only passed to the Merchant’s back-end ERP system for reconciliation purposes, and may not be displayed to the end customer.

MerchantDTBreakdown

object

Contains the duties and tax parts that the Merchant subsidized for the order.

MerchantGUID

string

Unique identifier of the Merchant on Global-e.

MerchantOrderId

string

Order unique identifier on the Merchant’s site returned from a previous call to the SendOrderToMerchant method for this order.

ModifiedProduct

string

Holds the product’s SKU

OrderCreationSource

enum<number>

One of the values of OrderCreationSource enumeration denoting a type of discount shown in the OrderCreationSource Table.

Available options:

0,

1

OrderDocuments

any[]

Always contains a single document - it can be either a VAT Invoice or a Customer Receipt, depends if it is within the EU or not.

OrderPaymentMethods

any[]

List of payment methods the customer use (Credit card, Gift Cards)

OrderStatusReason

object

Reason for the order status, why it was cancelled.

OriginalOrder

object

Details that refer to the original order if the current order is a replacement.

OTCurrencyCode

string

Currency of the one-time voucher code used to place the order.

OTVoucherAmount

number

The amount taken off the voucher when applicable.

OTVoucherCode

string

One-time voucher code used to place the order

Parcels

any[]

The list of parcels created for the order.

PaymentDetails

object

The paying customer’s payment details.

PrePayOffered

boolean

Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered.

PriceCoefficientRate

number

CountryCoefficient rate applied to the prices in this order.

PrimaryBilling

object

The primary customer’s billing details. If IsEndCustomerPrimary is set to TRUE, then the primary customer is the payer and his details are indicated in the URL-encoded form.

PrimaryShipping

object

Primary customer’s shipping details. If Customer.IsEndCustomerPrimary is TRUE, this field contains the end customers' shipping details. this field contains the Global-e hub's shipping address in the URL-encoded form.

Products

any[]

The list of products being purchased.

RoundingRate

number

The average conversion rate applied to the prices paid by the end customer when calculating the prices paid by Global‑e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors.

SameDayDispatch

boolean

Indicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout. TRUE - Customer requested "Same Day Dispatch" FALSE - Customer did not request "Same Day Dispatch"

SameDayDispatchCost

number

Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.

SecondaryBilling

object

Secondary customer’s billing details. If Customer.IsEndCustomerPrimary is FALSE, this contains attributes of the end customer’s details indicated in the URL-encoded form.

SecondaryShipping

object

Secondary customer’s shipping details. If Customer.IsEndCustomerPrimary is FALSE, this field contains the end customers' shipping details.

ShippingMethodCode

string

Code denoting the local shipping method selected from the list of available shipping options provided in the shippingOptionsList argument for the SendCart method for the cart converted to this order on Global‑e.

ShipToStoreCode

string

Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side).

StatusCode

string

Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).

Subs

any[]

Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed.

TotalDutiesAndTaxesPrice

number

Total Duties & Taxes value including Customs Clearance Fees, in the Merchant currency. This amount is the total amount, regardless of whether the customer or the Merchant paid it.

TotalDutiesPaidByCustomerPrice

number

The total amount of duties paid by the customer in the Merchant’s currency.

UserId

string

Internal User identifier on the Merchant’s site originally specified in the shippingDetails.UserIdargument for SendCart method for the cart converted to this order on Global‑e.

USSalesTax

number

Sales tax value for USA in the Merchant currency. This value is included in TotalDutiesAndTaxesPrice.

WebStoreCode

string

Code used on the Merchant’s side to identify the web store, as specified in the WebStoreCode argument for the SendCart method for the cart converted to this order on Global‑e.

Response

200 - application/json

Response Parameters

Response details regarding API call.

Description

string

Optional response description. In case of an error, this property indicates the error message description.

ErrorCode

string

Error code to be returned when an error occurs.

InternalOrderId

string

Order unique identifier on the Merchant’s site

Message

string

Optional response message. In case of an error, this property indicates the error message text.

OrderId

string

Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike the InternalOrderId, this identifier is not necessarily unique over time, as the Merchant’s site may potentially reuse it (for example after deleting the old order having the same OrderId).

PaymentAmount

string

The total payment amount in PaymentCurrency charged for the order (if payment was processed in the respective API method call).

PaymentCurrencyCode

string

3-char ISO currency code for the order (if payment was processed in the respective API method call).

StatusCode

string

Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).

Success

boolean

Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

Overview

Shipping

Orders

Returns

Gift Cards

Checkout

Pricing

Browsing & Catalog

Subscriptions

Webhooks

Shared Objects

Update Order Shipping Info (Global-e to Merchant)

Body

Response