Edit order (Merchant to Global-e)

Edit order

curl --request POST \
  --url https://{globale_api_domain}/api/orders/changes \
  --header 'Content-Type: application/json' \
  --data '
{
  "OrderId": "GE379858112TS",
  "RemovedProducts": [
    {
      "CartItemId": "1",
      "Quantity": 1
    }
  ],
  "NewProducts": [
    {
      "ProductCode": "750518703039M",
      "CartItemId": "2",
      "OrderedQuantity": 1,
      "OriginalSalePrice": 125.12,
      "ReplacementOfCartItemId": "1"
    }
  ],
  "SubsidizeHigherValue": 0
}
'

import requests

url = "https://{globale_api_domain}/api/orders/changes"

payload = {
    "OrderId": "GE379858112TS",
    "RemovedProducts": [
        {
            "CartItemId": "1",
            "Quantity": 1
        }
    ],
    "NewProducts": [
        {
            "ProductCode": "750518703039M",
            "CartItemId": "2",
            "OrderedQuantity": 1,
            "OriginalSalePrice": 125.12,
            "ReplacementOfCartItemId": "1"
        }
    ],
    "SubsidizeHigherValue": 0
}
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: 'GE379858112TS',
    RemovedProducts: [{CartItemId: '1', Quantity: 1}],
    NewProducts: [
      {
        ProductCode: '750518703039M',
        CartItemId: '2',
        OrderedQuantity: 1,
        OriginalSalePrice: 125.12,
        ReplacementOfCartItemId: '1'
      }
    ],
    SubsidizeHigherValue: 0
  })
};

fetch('https://{globale_api_domain}/api/orders/changes', 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://{globale_api_domain}/api/orders/changes",
  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' => 'GE379858112TS',
    'RemovedProducts' => [
        [
                'CartItemId' => '1',
                'Quantity' => 1
        ]
    ],
    'NewProducts' => [
        [
                'ProductCode' => '750518703039M',
                'CartItemId' => '2',
                'OrderedQuantity' => 1,
                'OriginalSalePrice' => 125.12,
                'ReplacementOfCartItemId' => '1'
        ]
    ],
    'SubsidizeHigherValue' => 0
  ]),
  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://{globale_api_domain}/api/orders/changes"

	payload := strings.NewReader("{\n  \"OrderId\": \"GE379858112TS\",\n  \"RemovedProducts\": [\n    {\n      \"CartItemId\": \"1\",\n      \"Quantity\": 1\n    }\n  ],\n  \"NewProducts\": [\n    {\n      \"ProductCode\": \"750518703039M\",\n      \"CartItemId\": \"2\",\n      \"OrderedQuantity\": 1,\n      \"OriginalSalePrice\": 125.12,\n      \"ReplacementOfCartItemId\": \"1\"\n    }\n  ],\n  \"SubsidizeHigherValue\": 0\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://{globale_api_domain}/api/orders/changes")
  .header("Content-Type", "application/json")
  .body("{\n  \"OrderId\": \"GE379858112TS\",\n  \"RemovedProducts\": [\n    {\n      \"CartItemId\": \"1\",\n      \"Quantity\": 1\n    }\n  ],\n  \"NewProducts\": [\n    {\n      \"ProductCode\": \"750518703039M\",\n      \"CartItemId\": \"2\",\n      \"OrderedQuantity\": 1,\n      \"OriginalSalePrice\": 125.12,\n      \"ReplacementOfCartItemId\": \"1\"\n    }\n  ],\n  \"SubsidizeHigherValue\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{globale_api_domain}/api/orders/changes")

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\": \"GE379858112TS\",\n  \"RemovedProducts\": [\n    {\n      \"CartItemId\": \"1\",\n      \"Quantity\": 1\n    }\n  ],\n  \"NewProducts\": [\n    {\n      \"ProductCode\": \"750518703039M\",\n      \"CartItemId\": \"2\",\n      \"OrderedQuantity\": 1,\n      \"OriginalSalePrice\": 125.12,\n      \"ReplacementOfCartItemId\": \"1\"\n    }\n  ],\n  \"SubsidizeHigherValue\": 0\n}"

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

{
  "OrderId": "GE379858112TS",
  "CurrencyCode": "GBP",
  "Products": [
    {
      "Sku": "750518703039M",
      "CartItemId": "2",
      "ParentCartItemId": null,
      "Quantity": 1,
      "Price": 125.12,
      "InternationalPrice": 160,
      "DiscountedPrice": 125.12,
      "InternationalDiscountedPrice": 160
    }
  ],
  "Discounts": [
    {
      "Name": "Hidden DDP",
      "Description": "Discount generated to discount the DDP",
      "Price": 8,
      "InternationalPrice": 10,
      "ProductCartItemId": null
    }
  ],
  "TotalDutiesAndTaxesPrice": 79.83,
  "USSalesTax": 0,
  "CCFPrice": 12.4,
  "TotalDutiesPaidByCustomerPrice": 0,
  "InternationalDetails": {
    "CurrencyCode": "EUR",
    "TotalPrice": 160,
    "TransactionCurrencyCode": "EUR",
    "TransactionTotalPrice": 160,
    "TotalShippingPrice": 0,
    "TotalCCFPrice": 14.79,
    "TotalDutiesPrice": 0,
    "USSalesTax": 0,
    "DutiesGuaranteed": true,
    "ConsignmentFee": 0,
    "DiscountedShippingPrice": 0
  }
}

{
  "Code": "B100",
  "Error": "OrderId is not provided.",
  "Description": "One or more of the documented validation rules failed. See the response message for the specific rule."
}

{
  "Error": "Order GE379858112TS status does not allow to make changes for the order.",
  "Description": "The order has reached a status that no longer permits product changes."
}

POST

api

orders

changes

Edit order

curl --request POST \
  --url https://{globale_api_domain}/api/orders/changes \
  --header 'Content-Type: application/json' \
  --data '
{
  "OrderId": "GE379858112TS",
  "RemovedProducts": [
    {
      "CartItemId": "1",
      "Quantity": 1
    }
  ],
  "NewProducts": [
    {
      "ProductCode": "750518703039M",
      "CartItemId": "2",
      "OrderedQuantity": 1,
      "OriginalSalePrice": 125.12,
      "ReplacementOfCartItemId": "1"
    }
  ],
  "SubsidizeHigherValue": 0
}
'

import requests

url = "https://{globale_api_domain}/api/orders/changes"

payload = {
    "OrderId": "GE379858112TS",
    "RemovedProducts": [
        {
            "CartItemId": "1",
            "Quantity": 1
        }
    ],
    "NewProducts": [
        {
            "ProductCode": "750518703039M",
            "CartItemId": "2",
            "OrderedQuantity": 1,
            "OriginalSalePrice": 125.12,
            "ReplacementOfCartItemId": "1"
        }
    ],
    "SubsidizeHigherValue": 0
}
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: 'GE379858112TS',
    RemovedProducts: [{CartItemId: '1', Quantity: 1}],
    NewProducts: [
      {
        ProductCode: '750518703039M',
        CartItemId: '2',
        OrderedQuantity: 1,
        OriginalSalePrice: 125.12,
        ReplacementOfCartItemId: '1'
      }
    ],
    SubsidizeHigherValue: 0
  })
};

fetch('https://{globale_api_domain}/api/orders/changes', 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://{globale_api_domain}/api/orders/changes",
  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' => 'GE379858112TS',
    'RemovedProducts' => [
        [
                'CartItemId' => '1',
                'Quantity' => 1
        ]
    ],
    'NewProducts' => [
        [
                'ProductCode' => '750518703039M',
                'CartItemId' => '2',
                'OrderedQuantity' => 1,
                'OriginalSalePrice' => 125.12,
                'ReplacementOfCartItemId' => '1'
        ]
    ],
    'SubsidizeHigherValue' => 0
  ]),
  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://{globale_api_domain}/api/orders/changes"

	payload := strings.NewReader("{\n  \"OrderId\": \"GE379858112TS\",\n  \"RemovedProducts\": [\n    {\n      \"CartItemId\": \"1\",\n      \"Quantity\": 1\n    }\n  ],\n  \"NewProducts\": [\n    {\n      \"ProductCode\": \"750518703039M\",\n      \"CartItemId\": \"2\",\n      \"OrderedQuantity\": 1,\n      \"OriginalSalePrice\": 125.12,\n      \"ReplacementOfCartItemId\": \"1\"\n    }\n  ],\n  \"SubsidizeHigherValue\": 0\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://{globale_api_domain}/api/orders/changes")
  .header("Content-Type", "application/json")
  .body("{\n  \"OrderId\": \"GE379858112TS\",\n  \"RemovedProducts\": [\n    {\n      \"CartItemId\": \"1\",\n      \"Quantity\": 1\n    }\n  ],\n  \"NewProducts\": [\n    {\n      \"ProductCode\": \"750518703039M\",\n      \"CartItemId\": \"2\",\n      \"OrderedQuantity\": 1,\n      \"OriginalSalePrice\": 125.12,\n      \"ReplacementOfCartItemId\": \"1\"\n    }\n  ],\n  \"SubsidizeHigherValue\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{globale_api_domain}/api/orders/changes")

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\": \"GE379858112TS\",\n  \"RemovedProducts\": [\n    {\n      \"CartItemId\": \"1\",\n      \"Quantity\": 1\n    }\n  ],\n  \"NewProducts\": [\n    {\n      \"ProductCode\": \"750518703039M\",\n      \"CartItemId\": \"2\",\n      \"OrderedQuantity\": 1,\n      \"OriginalSalePrice\": 125.12,\n      \"ReplacementOfCartItemId\": \"1\"\n    }\n  ],\n  \"SubsidizeHigherValue\": 0\n}"

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

{
  "OrderId": "GE379858112TS",
  "CurrencyCode": "GBP",
  "Products": [
    {
      "Sku": "750518703039M",
      "CartItemId": "2",
      "ParentCartItemId": null,
      "Quantity": 1,
      "Price": 125.12,
      "InternationalPrice": 160,
      "DiscountedPrice": 125.12,
      "InternationalDiscountedPrice": 160
    }
  ],
  "Discounts": [
    {
      "Name": "Hidden DDP",
      "Description": "Discount generated to discount the DDP",
      "Price": 8,
      "InternationalPrice": 10,
      "ProductCartItemId": null
    }
  ],
  "TotalDutiesAndTaxesPrice": 79.83,
  "USSalesTax": 0,
  "CCFPrice": 12.4,
  "TotalDutiesPaidByCustomerPrice": 0,
  "InternationalDetails": {
    "CurrencyCode": "EUR",
    "TotalPrice": 160,
    "TransactionCurrencyCode": "EUR",
    "TransactionTotalPrice": 160,
    "TotalShippingPrice": 0,
    "TotalCCFPrice": 14.79,
    "TotalDutiesPrice": 0,
    "USSalesTax": 0,
    "DutiesGuaranteed": true,
    "ConsignmentFee": 0,
    "DiscountedShippingPrice": 0
  }
}

{
  "Code": "B100",
  "Error": "OrderId is not provided.",
  "Description": "One or more of the documented validation rules failed. See the response message for the specific rule."
}

{
  "Error": "Order GE379858112TS status does not allow to make changes for the order.",
  "Description": "The order has reached a status that no longer permits product changes."
}

Applies to all platforms except Shopify. See the Editing Orders integration guide for prerequisites, constraints, and examples.

Body

application/json

Details of changes to the order, including products to add to or remove from the order.

OrderId

string

required

Global-e order ID.

NewProducts

Product · object[]

required

List providing information about the products.

Show child attributes

SubsidizeHigherValue

integer

required

In a quote request: set to 0 to receive the expected order values with no merchant subsidy discount applied in case of higher value; set to 1 to receive the expected order values including the merchant subsidy for the cost difference. In an edit request: set to 0 to avoid subsidizing the cost difference in case of a higher value (if the new order value is higher and the value is 0/null/empty, the editing request will fail); set to 1 to subsidize the additional cost between the original order value prior to the update and the updated value.

RemovedProducts

RemovedProduct · object[]

List providing information about removed products.

Show child attributes

Response

The updated Merchant.Order object.

MerchantGUID

string

Unique identifier of the Merchant on Global-e.

OrderId

string

Global-e order unique identifier.

MerchantOrderId

string

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

CartId

string

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

CartHash

string

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

StatusCode

string

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

CurrencyCode

string

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

PriceCoefficientRate

number

CountryCoefficient rate is applied to the prices in this order.

RoundingRate

number

The average conversion rate applied to the prices paid by the 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.

UserId

string

Optional. Internal User identifier on the Merchant's site originally specified in shippingDetails.UserId argument for the SendCart method for the cart converted to this order on Global-e.

ShippingMethodCode

string

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

ClearCart

boolean

Indicates if the end customer's cart must be cleared before this method finishes execution on the Merchant's site.

AllowMailsFromMerchant

boolean

Indicates if the end customer has opted for Global-e checkout to receive emails from the Merchant.

LoyaltyPointsSpent

number

Optional. 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 (on the user's My Account page).

LoyaltyPointsEarned

number

Optional. The number of loyalty points to be earned for this purchase by the 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.

LoyaltyCode

string

Optional. The loyalty code applicable to the Merchant's site is entered by the customer in Global-e checkout.

SameDayDispatch

boolean

Optional. Indicates if the customer has requested a "Same Day Dispatch" in the Global-e checkout.

SameDayDispatchCost

number

Optional. Cost of the "Same Day Dispatch" option selected by the end customer on Global-e checkout, in the original Merchant's currency.

DoNotChargeVAT

boolean

Optional. Indicates if the end customer has not 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.

IsFreeShipping

boolean

Optional. 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.

FreeShippingCouponCode

string

Optional. Merchant's free shipping coupon code 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.

ShipToStoreCode

string

Optional. Code denoting the Merchant's store specified by the customer for "ship to shop" shipping destination (to be mapped on the Global-e side).

CustomerComments

string

Optional. Comments text entered by the end customer in Global-e checkout.

IsSplitOrder

boolean

Optional. Indicates if the order should be handled as split order (i.e. without consolidation).

OTVoucherCode

string

Optional. One-time voucher code used to place the order.

OTCurrencyCode

string

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

OTVoucherAmount

number

Optional. Amount taken off the voucher when applicable.

WebStoreCode

string

Optional. 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.

Products

Merchant.Product · object[]

The list of products being purchased.

Show child attributes

Discounts

Merchant.Discount · object[]

Optional. 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.

Show child attributes

Markups

Merchant.Discount · object[]

Optional. 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 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.

Show child attributes

Customer

Merchant.Customer · object

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

Show child attributes

PrimaryBilling

Merchant.CustomerDetails · object

Primary customer's billing details. Primary customer denotes the paying (Global-e) customer unless Customer.IsEndCustomerPrimary is FALSE. Note that all string attributes of customer details are indicated in the URL-encoded form. Therefore, if the Customer.IsEndCustomerPrimary is TRUE then all string attributes in PrimaryBilling are URL encoded.

Show child attributes

PrimaryShipping

Merchant.CustomerDetails · object

Primary customer's shipping details. Primary customer denotes the paying (Global-e) customer unless Customer.IsEndCustomerPrimary is FALSE. Note that all string attributes of customer's details are indicated in URL encoded form. Therefore, if Customer.IsEndCustomerPrimary is TRUE then all string attributes in PrimaryShipping are URL encoded.

Show child attributes

PaymentDetails

Merchant.PaymentDetails · object

The paying customer's payment details.

Show child attributes

SecondaryBilling

Merchant.CustomerDetails · object

Secondary customer's billing details. Secondary customer denotes the end customer who has placed the order with Global-e checkout unless Customer.IsEndCustomerPrimary is FALSE. Note that all string attributes of customer's details are indicated in URL encoded form. Therefore, if Customer.IsEndCustomerPrimary is FALSE then all string attributes in SecondaryBilling are URL encoded.

Show child attributes

SecondaryShipping

Merchant.CustomerDetails · object

Secondary customer's shipping details. Secondary customer denotes the end customer who has placed the order with Global-e checkout unless Customer.IsEndCustomerPrimary is FALSE. Note that all string attributes of customer's details are indicated in URL encoded form. Therefore, if Customer.IsEndCustomerPrimary is FALSE then all string attributes in SecondaryShipping are URL encoded.

Show child attributes

InternationalDetails

Merchant.InternationalDetails · object

Optional. Details referring to the customer's order placed on the Global-e side. These details are applicable only to the Merchants dealing with international customers' support themselves.

Show child attributes

DiscountedShippingPrice

number

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

PrePayOffered

boolean

Indicates if the prepayment option for duties and taxes was offered to the customer.

IsReplacementOrder

boolean

Indicates if the order is a replacement.

OriginalOrder

Merchant.OriginalOrder · object

Optional. Details referring to the original order if the current order is a replacement.

Show child attributes

DateCreated

string

Order creation date and time.

CurrencyName

string

Customer currency name.

Parcels

Merchant.Parcel · object[]

The list of parcels created for the order.

Show child attributes

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.

CCFPrice

number

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

TotalDutiesPaidByCustomerPrice

number

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

USSalesTax

number

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

ExporterDetails

Merchant.ExporterDetails · object

Exporter details (relevant EIN / EORI / VAT

Show child attributes

ImporterDetails

Merchant.ImporterDetails · object

Importer details (relevant EIN / EORI / VAT

Show child attributes

DeclarativeShippingPriceInCustomerCurrency

number

Shipping cost used for declarative purposes. If the value is 0 (free shipping), a non-zero low value is recommended (may attract duties and taxes). By default, if the customer benefits from Free Shipping, 5 USD is added instead for declarative purposes — this can be disabled by the Global-e team.

TaxCalculationRule

enum<string>

Indicates if destination Duties & Tax calculation is based on Products, Freight, and Duties. Possible values are accordingly: FOB, CIF, CIFD.

Available options:

FOB,

CIF,

CIFD

TotalValueForCustoms

number

Total shipment declarative value for customs. Calculated to include Products, Freight, and Duties.

AdditionalRequiredDocuments

OrderDocument · object[]

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

Show child attributes

CashOnDeliveryFee

number

Cash On Delivery fee amount in Merchant's currency.

CustomerDTBreakdown

DTBreakdown · object

Contains the duties and tax parts the customer paid for the order. Not returned in this response. For the breakdown of the edited order, see InternationalDetails.CustomerDTBreakdown.

Show child attributes

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. Always false in this response, regardless of the order.

IsMoto

boolean

Indicates if 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. Always false in this response, regardless of the order.

IsTaxExemption

boolean

Indicates if the order has a tax exemption. TRUE - Order has a tax exemption. FALSE - Order does not have a tax exemption. Always false in this response, regardless of the order.

MerchantDTBreakdown

DTBreakdown · object

Contains the duties and tax parts that the Merchant subsidized for the order. Not returned in this response. For the breakdown of the edited order, see InternationalDetails.MerchantDTBreakdown.

Show child attributes

ModifiedProduct

string

Holds the product's SKU. Always null in this response.

OrderCreationSource

enum<integer>

One of the values of the OrderCreationSource enumeration, denoting the source the order was created from. 0 = GECheckout (orders created in a normal flow via Global-e Checkout). 1 = Marketplace (orders created at a marketplace and sent to Global-e via your brand). Always 0 in this response, regardless of the order.

Available options:

0,

1

OrderDocuments

OrderDocument · object[]

The order's VAT Invoice or Customer Receipt, depending on whether the order is within the EU. Always null in this response.

Show child attributes

OrderPaymentMethods

OrderPaymentMethod · object[]

List of payment methods the customer used (Credit card, Gift Cards). In this response, the list always contains one entry, and only PaymentMethodId is populated.

Show child attributes

OrderStatusReason

OrderStatusReason · object

Reason for the order status, why it was cancelled.

Show child attributes

Subs

array

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

Overview

Shipping

Orders

Returns

Gift Cards

Checkout

Pricing

Browsing & Catalog

Subscriptions

Webhooks

Shared Objects

Edit order (Merchant to Global-e)

Body

Response