CreateOrderPlatform
This API starts the process of creating an order in the Global-e system. OrderCreationSource is an important attribute in the Class SendFinalCartData and the value of OrderCreationSource can be called in different ways in the order creation process.
URL
https://{server_name}/Checkout/CreateOrderPlatform
Parameters
Request
Provides full CheckoutCartInfo details.
Name | Type | Description | Mandatory |
|---|---|---|---|
| Object | Full cart data for the order creation process. |
Return
Name | Type | Description |
|---|---|---|
| Object | Indicates if the API call was successful. |
Examples
Request
{
"ShippingDetails": {
"UserId": "5920775766266",
"UserIdNumber": null,
"UserIdNumberType": null,
"FirstName": "Tema",
"LastName": "Test",
"FirstNameInLocalCulture": null,
"LastNameInLocalCulture": null,
"MiddleName": null,
"Salutation": null,
"Phone1": "3000000001",
"Phone2": null,
"Fax": null,
"Email": "[email protected]",
"Address1": "ORREGO LUCO 54",
"Address2": "",
"City": "PROVIDENCIA",
"CityRegion": null,
"StateOrProvince": "Maule",
"Zip": "7510115",
"CountryCode": "CL",
"StateCode": "ML",
"Company": null
},
"BillingDetails": {
"UserId": "5920775766266",
"UserIdNumber": null,
"UserIdNumberType": null,
"FirstName": "Tema",
"LastName": "Test",
"FirstNameInLocalCulture": null,
"LastNameInLocalCulture": null,
"MiddleName": null,
"Salutation": null,
"Phone1": "3000000000",
"Phone2": null,
"Fax": null,
"Email": "[email protected]",
"Address1": "ORREGO LUCO 54",
"Address2": "",
"City": "PROVIDENCIA",
"CityRegion": null,
"StateOrProvince": "Maule",
"Zip": "7510115",
"CountryCode": "CL",
"StateCode": "ML",
"Company": null
},
"ShippingMethodId": "40032680",
"IsTaxPrePaid": true,
"IsSameDayDispatchSelected": false,
"GiftCards": null,
"CustomerPayments": {
"Duties": 5807.0,
"Taxes": 19491.0,
"CustomClearanceFee": 0.0,
"ShippingPrice": 11377.0,
"Total": 122075.0
},
"CheckoutUrl": "https://globale-dev.myshopify.com/56721965226/checkouts/
372520cb016c0fdb8459367755b69113?key=667dc86bdac6597af3ad9b2229c8397f",
"MarketplaceData": null,
"OrderReplacementData": null,
"OrderData": null,
"IsMarketplaceOrder": false,
"IsReplacementOrder": false,
"IsOOS": true,
"IsSyncOrder": false,
"CountryCode": "CL",
"ClientIP": null,
"Currency": {
"OriginalCurrencyCode": "GBP",
"CurrencyCode": "CLP"
},
"PriceModification": null,
"Culture": {
"PreferedCultureCode": null,
"InputDataCultureCode": "en",
"CultureCode": null
},
"LocalShippingOptions": [{
"Carrier": "globaleintegration_standard",
"CarrierTitle": "globaleintegration_standard",
"CarrierName": "globaleintegration_standard",
"Code": "globaleintegration_standard",
"Method": "globaleintegration_standard",
"MethodTitle": "globaleintegration_standard",
"MethodDescription": "globaleintegration_standard",
"Price": 0.0,
"IsPreferred": true
}
],
"Products": [{
"ProductCode": "40166999589034",
"ProductGroupCode": "6707847102634",
"Name": "ADIDAS | CLASSIC BACKPACK BBBB",
"NameEnglish": null,
"Keywords": null,
"URL": null,
"Description": null,
"DescriptionEnglish": null,
"GenericHSCode": null,
"Weight": "0",
"Height": null,
"Length": null,
"Width": null,
"Volume": null,
"ImageURL": "https://cdn.shopify.com/s/files/1/0567/2196/5226/products/
85cc58608bf138a50036bcfe86a3a362.jpg?v=1620302515",
"ImageWidth": null,
"ImageHeight": null,
"OriginCountryCode": null,
"ListPrice": "115000.0",
"OriginalListPrice": null,
"SalePrice": "85400.0",
"OriginalSalePrice": null,
"UnitSalePriceForDuties": null,
"SalePriceBeforeRounding": null,
"OriginalSalePriceAfterGlobalEDiscount": null,
"OriginalSalePriceAfterRounding": null,
"VATRateType": {
"VATRateTypeCode": "vatRateType_GB_20",
"Name": "vatRateType_GB_20",
"Rate": 20.0,
"InternalVATRateTypeId": 0
},
"LocalVATRateType": {
"VATRateTypeCode": "vatRateType_GB_20",
"Name": "vatRateType_GB_20",
"Rate": 20.0,
"InternalVATRateTypeId": 0
},
"Brand": {
"BrandCode": "ADIDAS",
"Name": "ADIDAS"
},
"Categories": [{
"CategoryCode": "2222",
"Name": "2222"
}, {
"CategoryCode": "adidas",
"Name": "adidas"
}, {
"CategoryCode": "backpack",
"Name": "backpack"
}, {
"CategoryCode": "egnition-sample-data",
"Name": "egnition-sample-data"
}, {
"CategoryCode": "getest",
"Name": "getest"
}, {
"CategoryCode": "globaleteg",
"Name": "globaleteg"
}, {
"CategoryCode": "men",
"Name": "men"
}, {
"CategoryCode": "pc - test2",
"Name": "pc - test2"
}
],
"OrderedQuantity": 1,
"DeliveryQuantity": -1,
"CartItemId": "40166999589034-0",
"ParentCartItemId": null,
"CartItemOptionId": null,
"IsBlockedForGlobalE": false,
"IsBundle": null,
"Attributes": null,
"AttributesEnglish": null,
"MetaData": {
"Attributes": [{
"AttributeKey": "backpack",
"AttributeValue": "backpack"
}
]
},
"IsFixedPrice": true,
"HandlingCode": null,
"NetWeight": null,
"NetVolume": null,
"IsVirtual": false,
"ProductGroupCodeSecondary": null,
"ProductCodeSecondary": "123456",
"GiftMessage": null,
"OriginalMerchantUnitSalePrice": null,
"VATCategory": null,
"IsBackOrdered": false,
"BackOrderDate": null,
"ProductClassCode": null,
"PriceCoefficientRate": null,
"IsGiftCard": false,
"GiftCardId": null,
"PlatformIsActive": null,
"MerchantPriceForDuties": null,
"HubCode": null,
"OriginalSalePriceAfterDiscounts": null,
"EstimatedDeliveryDate": null,
"AvailableQuantity": null
}
],
"CartToken": null,
"MerchantCartToken": "372520cb016c0fdb8459367755b69113",
"MerchantCartHash": "nf2JfTVEveA+Sn53c7Fo0w==",
"HubId": null,
"PaymentInstallments": null,
"UserDetails": {
"UserId": "5920775766266",
"IsB2B": false,
"AddressDetails": [{
"FirstName": "Test",
"LastName": "Test",
"Email": "[email protected]",
"Phone1": "3000000000",
"Address1": "ORREGO LUCO 54",
"City": "Colorado",
"Zip": "7510114",
"CountryCode": "CL"
}
]
},
"UrlParameters": null,
"Discounts": [],
"Benefits": null,
"VATRegistration": null,
"FreeShipping": null,
"VoucherData": null,
"LoyaltyData": null,
"SessionId": null,
"AuthToken": null,
"UseIpv6": false,
"rateData": null,
"WebStoreCode": "globale-dev.myshopify.com",
"WebStoreInstanceCode": null,
"LoyaltyPoints": null,
"AllowMailsFromMerchant": false,
"AllowDirectCommunicationFromMerchant": false,
"CartId": null,
"MerchantOrderId": "TestMerchantOrderId",
"MerchantInternalOrderId": "TestMerchantInternalOrderId",
"BillingCustomFields": null,
"ShippingCustomFields": null,
"ShippingMethodCode": null,
"ShippingServiceCode": "DHL",
"OrderCreationSource": "ShopifyAPI"
}