> ## Documentation Index
> Fetch the complete documentation index at: https://docs-stage.bglobale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create order platform

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

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.


## OpenAPI

````yaml api-reference/specs/createorderplatform.yaml POST /Checkout/CreateOrderPlatform
openapi: 3.0.3
info:
  title: CreateOrderPlatform
  version: 1.0.0
  x-scaled-review: true
  description: >-
    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.
servers:
  - url: https://{server_name}
    variables:
      server_name:
        default: server_name
        description: Global-e Checkout API host, supplied to the merchant by Global-e.
security: []
tags:
  - name: CreateOrderPlatform
    x-page-title: CreateOrderPlatform
  - name: 'Direction: Merchant → Global-e'
  - name: 'Domain: Orders'
paths:
  /Checkout/CreateOrderPlatform:
    post:
      tags:
        - CreateOrderPlatform
      description: >-
        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.
      operationId: createOrderPlatform
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendFinalCartData'
            example:
              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: civentest@gmail.com
                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: civentest@gmail.com
                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: civentest@gmail.com
                    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
      responses:
        '200':
          description: Indicates if the API call was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseInfo'
components:
  schemas:
    SendFinalCartData:
      type: object
      title: SendFinalCartData
      description: Full cart data for the order creation process.
      properties:
        BillingDetails:
          $ref: '#/components/schemas/UserDetails'
        CheckoutUrl:
          type: string
          description: >-
            Checkout URL; it redirects you to the checkout or confirmation page
            (different URL for each Merchant)
        CustomerPayments:
          $ref: '#/components/schemas/FinalCustomerPayments'
        GiftCards:
          type: array
          description: The collection of GiftCards that were applied to the cart
          items:
            $ref: '#/components/schemas/CheckoutInfoGiftCard'
        IsSameDayDispatchSelected:
          type: boolean
          description: >-
            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:
          type: boolean
          description: >-
            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:
          $ref: '#/components/schemas/MarketplaceData'
        OrderCreationSource:
          $ref: '#/components/schemas/OrderCreationSource'
        OrderData:
          $ref: '#/components/schemas/CreateSyncOrderData'
        OrderReplacementData:
          $ref: '#/components/schemas/OrderReplacementData'
        ShippingDetails:
          $ref: '#/components/schemas/UserDetails'
        ShippingMethodId:
          type: string
          description: The ID of the shipping option selected by the customer
    ResponseInfo:
      type: object
      title: ResponseInfo
      description: Indicates if the API call was successful.
      properties:
        Success:
          type: boolean
          description: |-
            Indicates if the call was successful.
            TRUE - Call was successful.
            FALSE - Call not successful. ErrorInfo will be returned.
        Reason:
          type: string
          description: Text that optionally describes the reason for Success status.
    UserDetails:
      type: object
      title: UserDetails
      properties:
        Address1:
          type: string
          description: Address line 1
        Address2:
          type: string
          description: Address line 2
        City:
          type: string
          description: City name
        Company:
          type: string
          description: Company name
        CountryCode:
          type: string
          description: 2-char ISO country code
        CountryName:
          type: string
          description: Country name
        Email:
          type: string
          description: E-mail address
        Fax:
          type: string
          description: Fax
        FirstName:
          type: string
          description: First name
        FirstNameInLocalCulture:
          type: string
          description: 'First name in local culture Ex: Kana Japanese dialect'
        LastName:
          type: string
          description: Last name
        LastNameInLocalCulture:
          type: string
          description: 'Last name in local culture Ex: Kana Japanese dialect'
        MiddleName:
          type: string
          description: Middle name
        Phone1:
          type: string
          description: 'Phone #1'
        Phone2:
          type: string
          description: 'Phone #2'
        Salutation:
          type: string
          description: Salutation or title (e.g. Dr., Mr., etc.)
        StateCode:
          type: string
          description: State or province ISO code such as AZ for Arizona (if applicable)
        StateOrProvice:
          type: string
          description: State or province name
        UserId:
          type: string
          description: Internal User identifier on the Merchant site
        UserIdNumber:
          type: string
          description: User’s personal ID document number
        UserIdNumberType:
          $ref: '#/components/schemas/UserIdNumberType'
        Zip:
          type: string
          description: Zip or postal code
    FinalCustomerPayments:
      type: object
      title: FinalCustomerPayments
      description: >-
        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
      properties:
        CustomClearanceFee:
          type: number
          description: The customs clearance fee.
        Duties:
          type: number
          description: The cost of duties.
        ShippingPrice:
          type: number
          description: The shipping price.
        Taxes:
          type: number
          description: The tax component of the customer payment.
        Total:
          type: number
          description: The total customer payment.
    CheckoutInfoGiftCard:
      type: object
      title: Merchant.CheckoutInfoGiftCard
      properties:
        CardFields:
          type: object
          description: The gift card fields filled in the checkout
          additionalProperties:
            type: string
        ValidationResult:
          $ref: '#/components/schemas/ValidateGiftCardResponse'
    MarketplaceData:
      type: object
      title: MarketplaceData
      description: Marketplace information received by the API
      properties:
        MarketplaceId:
          type: number
          description: Marketplace ID.
        MarketplaceOrderId:
          type: string
          description: Marketplace order ID.
    OrderCreationSource:
      type: integer
      title: OrderCreationSource
      description: |-
        Source where order was created. Can be one of the following:
        GECheckout = 0
        Marketplace = 1
        ExternalApp = 2
        ShopifyAPI = 3
      enum:
        - 0
        - 1
        - 2
        - 3
    CreateSyncOrderData:
      type: object
      title: CreateSyncOrderData
      description: Information about the order
      properties:
        CCAuthorizationToken:
          type: string
          description: The custom clearance authorization token
        CustomerPayments:
          $ref: '#/components/schemas/CreateOrderFinalCustomerPayments'
        ExternalOperationId:
          type: string
          description: An external operation ID
        IsTaxPrePaid:
          type: boolean
          description: |-
            Identifies if taxes were prepaid.
            TRUE - taxes were prepaid
            FALSE - taxes were not prepaid
        OrderType:
          $ref: '#/components/schemas/ESyncOrderType'
        Source:
          type: string
          description: Order source
    OrderReplacementData:
      type: object
      title: OrderReplacementData
      description: Order replacement information received by the API
      properties:
        OrderReplacementType:
          type: number
          description: |-
            The type of replacement:
            1 - Repair Service
            0 - Regular replacement order (default)
        OriginalOrderId:
          type: string
          description: The original Order Id
        ReplacedProducts:
          type: array
          description: A list of replaced products
          items:
            $ref: '#/components/schemas/ReplacedProduct'
    UserIdNumberType:
      type: object
      title: UserIdNumberType
      description: User’s personal ID document type (e.g. Passport, ID card, etc.)
      properties:
        Name:
          type: string
          description: Identification document type name
        UserIdNumberTypeCode:
          type: string
          description: >-
            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)
    ValidateGiftCardResponse:
      type: object
      title: ValidateGiftCardResponse
      description: The gift card validation result
      properties:
        Balance:
          type: number
          description: The available amount of money on a gift card
        CurrencyCode:
          type: string
          description: Code of card currency
        ErrorCode:
          type: string
          description: Code of the error
        ErrorText:
          type: string
          description: Error message
        IsGlobalEGiftCard:
          type: boolean
          description: |-
            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:
          type: boolean
          description: |-
            The flag which approves that user entered the correct card data.
            TRUE - Card data is valid.
            FALSE - Card data is not valid.
    CreateOrderFinalCustomerPayments:
      type: object
      title: CreateOrderFinalCustomerPayments
      description: Provides details about the customer payment
      properties:
        CustomClearanceFee:
          type: number
          description: The final custom clearance fee for the order
        Duties:
          type: number
          description: The final cost of duties for the order
        ShippingPrice:
          type: number
          description: The final shipping price for the order
        Taxes:
          type: number
          description: Taxes applicable for the order
    ESyncOrderType:
      type: integer
      title: eSyncOrderType
      description: |-
        The type of order. Includes the following:
        None = 0
        Raffle = 1
        FlashSale = 2
        Collection = 3
      enum:
        - 0
        - 1
        - 2
        - 3
    ReplacedProduct:
      type: object
      title: ReplacedProduct
      properties:
        CartItemId:
          type: string
          description: Cart item ID
        Quantity:
          type: number
          description: Item quantity
        SKU:
          type: string
          description: SKU of the product if cart item id is not available

````