Create order platform

This API starts the process of creating an order in the Global-e system.

POST /Checkout/CreateOrderPlatform

cURL

cURL

curl --request POST \
  --url https://{server_name}/Checkout/CreateOrderPlatform \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": "[e-mail]",
    "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": "[e-mail]",
    "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,
    "Taxes": 19491,
    "CustomClearanceFee": 0,
    "ShippingPrice": 11377,
    "Total": 122075
  },
  "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,
      "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,
        "InternalVATRateTypeId": 0
      },
      "LocalVATRateType": {
        "VATRateTypeCode": "vatRateType_GB_20",
        "Name": "vatRateType_GB_20",
        "Rate": 20,
        "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": "[e-mail]",
        "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"
}
'

200

{
  "Success": true,
  "Reason": "<string>"
}

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.

Body

application/json

Full cart data for the order creation process.

BillingDetails · UserDetails · object

Show child attributes

CheckoutUrl · string

Checkout URL; it redirects you to the checkout or confirmation page (different URL for each Merchant)

CustomerPayments · FinalCustomerPayments · object

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

Show child attributes

GiftCards · Merchant.CheckoutInfoGiftCard · object[]

The collection of GiftCards that were applied to the cart

Show child attributes

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 · MarketplaceData · object

Marketplace information received by the API

Show child attributes

OrderCreationSource · enum<integer>

Source where order was created. Can be one of the following: GECheckout = 0 Marketplace = 1 ExternalApp = 2 ShopifyAPI = 3

Available options: 0, 1, 2, 3

OrderData · CreateSyncOrderData · object

Information about the order

Show child attributes

OrderReplacementData · OrderReplacementData · object

Order replacement information received by the API

Show child attributes

ShippingDetails · UserDetails · object

Show child attributes

ShippingMethodId · string

The ID of the shipping option selected by the customer

Response

200 - application/json

Indicates if the API call was successful.

Indicates if the API call was successful.

Success · boolean

Indicates if the call was successful. TRUE - Call was successful. FALSE - Call not successful. ErrorInfo will be returned.

Reason · string

Text that optionally describes the reason for Success status.