Skip to main content

Documentation Portal

SendFinalCartData extends SendCartData

Parameter Name	Type	Description	Mandatory
`BillingDetails`	Object `UserDetails`	Billing details entered by the customer in the checkout form
`CheckoutUrl`	String	Checkout URL; it redirects you to the checkout or confirmation page (different URL for each Merchant)
`CustomerPayments`	Object `FinalCustomerPayments`	The values of total duties, total taxes, total additional fees (like Custom Clearance Fee), shipping price, and total that was shown to the customer on the checkout page
`GiftCards`	List of `Merchant.CheckoutInfoGiftCard`	The collection of `GiftCards` that were applied to the cart
`IsSameDayDispatchSelected`	Boolean	Indicates if the user selected an option to dispatch the order on the same day TRUE - Selected to dispatch order on the same day FALSE - Did not select to dispatch order on the same day
`IsTaxPrePaid`	Boolean	Indicates if the end customer has selected or has been forced to prepay duties & taxes TRUE - Selected to prepay taxes FALSE - Did not select to prepay taxes
`MarketplaceData`	Object `MarketplaceData`	Marketplace information received by the API
`OrderCreationSource`	Object `OrderCreationSource`	Source for the order creation process
`OrderData`	Object `CreateSyncOrderData`	Information about the order
`OrderReplacementData`	Object `OrderReplacementData`	Order replacement information received by the API
`ShippingDetails`	Object `UserDetails`	Shipping details entered by the customer in the checkout form. If `CountryCode` is included, it is ignored (a new `InitCheckout` call is required if the shipping country is changed)
`ShippingMethodId`	String	The ID of the shipping option selected by the customer

CheckoutInfoGiftCard

Parameter Name	Type	Description	Mandatory
`CardFields`	Dictionary<String, String>	The gift card fields filled in the checkout
`ValidationResult`	Object `ValidateGiftCardResponse`	The gift card validation result

ValidateGiftCardResponse

Parameter Name	Type	Description	Mandatory
`Balance`	Decimal	The available amount of money on a gift card
`CurrencyCode`	String	Code of card currency
`ErrorCode`	String	Code of the error
`ErrorText`	String	Error message
`IsGlobalEGiftCard`	Boolean	Identifies if the gift card was bought from Global‑e. TRUE - Gift card was purchased from Global-e. FALSE - Gift card was not purchased from Global-e.
`IsValid`	Boolean	The flag which approves that user entered the correct card data. TRUE - Card data is valid. FALSE - Card data is not valid.

CreateSyncOrderData

Parameter Name	Type	Description	Mandatory
`CCAuthorizationToken`	String	The custom clearance authorization token
`CustomerPayments`	Object `CreateOrderFinalCustomerPayments`	Provides details about the customer payment
`ExternalOperationId`	String	An external operation ID
`IsTaxPrePaid`	Boolean	Identifies if taxes were prepaid. TRUE - taxes were prepaid FALSE - taxes were not prepaid
`OrderType`	Object `eSyncOrderType`	The type of order. Includes the following: None = 0 Raffle = 1 FlashSale = 2 Collection = 3
`Source`	String	Order source

CreateOrderFinalCustomerPayments

Parameter Name	Type	Description	Mandatory
`CustomClearanceFee`	Decimal	The final custom clearance fee for the order
`Duties`	Decimal	The final cost of duties for the order
`ShippingPrice`	Decimal	The final shipping price for the order
`Taxes`	Decimal	Taxes applicable for the order

FinalCustomerPayments

Parameter Name	Type	Description	Mandatory
`CustomClearanceFee`	Decimal	The customs clearance fee.
`Duties`	Decimal	The cost of duties.
`ShippingPrice`	Decimal	The shipping price.
`Taxes`	Decimal	The tax component of the customer payment.
`Total`	Decimal	The total customer payment.

OrderReplacementData

Parameter Name	Type	Description	Mandatory
`OrderReplacementType`	Number	The type of replacement: 1 - Repair Service 0 - Regular replacement order (default)	No
`OriginalOrderId`	String	The original Order Id
`ReplacedProducts`	List of `ReplacedProduct`	A list of replaced products

UserDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`City`	String	City name	No
`Company`	String	Company name	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name	No
`Email`	String	E-mail address	No
`Fax`	String	Fax	No
`FirstName`	String	First name	No
`FirstNameInLocalCulture`	String	First name in local culture Ex: Kana Japanese dialect	No
`LastName`	String	Last name	No
`LastNameInLocalCulture`	String	Last name in local culture Ex: Kana Japanese dialect	No
`MiddleName`	String	Middle name	No
`Phone1`	String	Phone #1	No
`Phone2`	String	Phone #2	No
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.)	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvice`	String	State or province name	No
`UserId`	String	Internal User identifier on the Merchant site	No
`UserIdNumber`	String	User’s personal ID document number	No
`UserIdNumberType`	Object `UserIdNumberType`	User’s personal ID document type (e.g. Passport, ID card, etc.)	No
`Zip`	String	Zip or postal code	No

UserIdNumberType

Parameter Name	Type	Description	Mandatory
`Name`	String	Identification document type name
`UserIdNumberTypeCode`	String	Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side)

Would you like to provide feedback? Just click here to suggest edits.