> ## Documentation Index
> Fetch the complete documentation index at: https://developers.qshop.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Order

> **Host**: http://qshop.ng



## OpenAPI

````yaml post /shops/{shopId}/orders
openapi: 3.1.0
info:
  title: OpenAPI Specification
  version: 1.0.0
  description: >-
    QShop storefront API.  This API is used to build a storefront for a QShop
    store
  contact:
    name: QShop
    url: https://qshop.ng
    email: hello@qshop.ng
servers:
  - url: http://staging.qshop.ng/apiv2
    description: Staging server
  - url: http://qshop.ng/api
    description: Production server
security: []
paths:
  /shops/{shopId}/orders:
    post:
      tags:
        - Shops
        - Orders
      summary: Create Order
      description: '**Host**: http://qshop.ng'
      parameters:
        - name: shopId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                notes:
                  type: string
                cartId:
                  type: string
                returnUrl:
                  type: string
                billingDetails:
                  type: object
                  properties:
                    fullName:
                      type: string
                    contact:
                      type: object
                      properties:
                        whatsApp:
                          type: string
                        telephone:
                          type: string
                        email:
                          type: string
                      required:
                        - whatsApp
                        - telephone
                        - email
                    address:
                      type: string
                    line_1:
                      type: string
                    line_2:
                      type: string
                    stateData:
                      type: string
                    countryData:
                      type: string
                    cityData:
                      type: string
                    area:
                      type: string
                    geoLocation:
                      type: object
                      properties:
                        fullAddress:
                          type: string
                        zipCode:
                          type: string
                        coordinates:
                          type: object
                          properties:
                            lng:
                              type: number
                            lat:
                              type: number
                          required:
                            - lng
                            - lat
                        points:
                          type: object
                          properties:
                            type:
                              type: string
                            coordinates:
                              type: array
                              items:
                                type: number
                            _id:
                              type: string
                          required:
                            - type
                            - coordinates
                            - _id
                        addressProximity:
                          type: string
                        geoNames:
                          type: array
                          items:
                            type: object
                            properties:
                              lng:
                                type: string
                              geonameId:
                                type: integer
                              name:
                                type: string
                              fclName:
                                type: string
                              toponymName:
                                type: string
                              fcodeName:
                                type: string
                              adminName1:
                                type: string
                              lat:
                                type: string
                              fcl:
                                type: string
                              fcode:
                                type: string
                              population:
                                type: integer
                              adminCode1:
                                type: string
                              countryId:
                                type: string
                              countryCode:
                                type: string
                              countryName:
                                type: string
                              adminCodes1:
                                type: object
                                properties:
                                  ISO3166_2:
                                    type: string
                                required:
                                  - ISO3166_2
                            required:
                              - lng
                              - geonameId
                              - name
                              - fclName
                              - toponymName
                              - fcodeName
                              - adminName1
                              - lat
                              - fcl
                              - fcode
                              - population
                        google:
                          type: object
                          properties:
                            address_components:
                              type: array
                              items:
                                type: object
                                properties:
                                  long_name:
                                    type: string
                                  short_name:
                                    type: string
                                  types:
                                    type: array
                                    items:
                                      type: string
                                required:
                                  - long_name
                                  - short_name
                                  - types
                            adr_address:
                              type: string
                            formatted_address:
                              type: string
                            geometry:
                              type: object
                              properties:
                                location:
                                  type: object
                                  properties:
                                    lat:
                                      type: number
                                    lng:
                                      type: number
                                  required:
                                    - lat
                                    - lng
                                viewport:
                                  type: object
                                  properties:
                                    south:
                                      type: number
                                    west:
                                      type: number
                                    north:
                                      type: number
                                    east:
                                      type: number
                                  required:
                                    - south
                                    - west
                                    - north
                                    - east
                              required:
                                - location
                                - viewport
                            name:
                              type: string
                            types:
                              type: array
                              items:
                                type: string
                            utc_offset:
                              type: integer
                            html_attributions:
                              type: array
                            utc_offset_minutes:
                              type: integer
                          required:
                            - address_components
                            - adr_address
                            - formatted_address
                            - geometry
                            - name
                            - types
                            - utc_offset
                            - html_attributions
                            - utc_offset_minutes
                        _id:
                          type: string
                      required:
                        - fullAddress
                        - zipCode
                        - coordinates
                        - points
                        - addressProximity
                        - geoNames
                        - google
                        - _id
                    isDefault:
                      type: boolean
                    _id:
                      type: string
                    id:
                      type: string
                  required:
                    - fullName
                    - contact
                    - address
                    - line_1
                    - line_2
                    - stateData
                    - countryData
                    - cityData
                    - area
                    - geoLocation
                    - isDefault
                    - _id
                    - id
                whatsApp:
                  type: boolean
                digital:
                  type: boolean
                deliveryType:
                  type: string
                currency:
                  type: string
                paymentMethod:
                  type: string
              required:
                - notes
                - cartId
                - returnUrl
                - billingDetails
                - whatsApp
                - digital
                - deliveryType
                - currency
                - paymentMethod
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    anyOf:
                      - type: 'null'
                      - type: object
                        properties:
                          _id:
                            type: string
                          orderNo:
                            type: string
                          __v:
                            type: integer
                          amountSaved:
                            type: integer
                          created:
                            type: string
                          customer:
                            type: object
                            properties:
                              shop:
                                type: string
                              full_name:
                                type: string
                              telephone:
                                type: string
                              intlTel:
                                type: string
                              whatsApp:
                                type: string
                              address:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    line_1:
                                      type: string
                                    line_2:
                                      type: string
                                    state:
                                      type: string
                                    city:
                                      type: string
                                    country:
                                      type: string
                                    zip_code:
                                      type: string
                                    state_id:
                                      type: string
                                    geoLocation:
                                      type: object
                                      properties:
                                        fullAddress:
                                          type: string
                                        zipCode:
                                          type: string
                                        coordinates:
                                          type: object
                                          properties:
                                            lng:
                                              type: number
                                            lat:
                                              type: number
                                          required:
                                            - lng
                                            - lat
                                        points:
                                          type: object
                                          properties:
                                            type:
                                              type: string
                                            coordinates:
                                              type: array
                                              items:
                                                type: number
                                            _id:
                                              type: string
                                          required:
                                            - type
                                            - coordinates
                                            - _id
                                        addressProximity:
                                          type: string
                                        geoNames:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              lng:
                                                type: string
                                              geonameId:
                                                type: integer
                                              name:
                                                type: string
                                              fclName:
                                                type: string
                                              toponymName:
                                                type: string
                                              fcodeName:
                                                type: string
                                              adminName1:
                                                type: string
                                              lat:
                                                type: string
                                              fcl:
                                                type: string
                                              fcode:
                                                type: string
                                              population:
                                                type: integer
                                              adminCode1:
                                                type: string
                                              countryId:
                                                type: string
                                              countryCode:
                                                type: string
                                              countryName:
                                                type: string
                                              adminCodes1:
                                                type: object
                                                properties:
                                                  ISO3166_2:
                                                    type: string
                                                required:
                                                  - ISO3166_2
                                            required:
                                              - lng
                                              - geonameId
                                              - name
                                              - fclName
                                              - toponymName
                                              - fcodeName
                                              - adminName1
                                              - lat
                                              - fcl
                                              - fcode
                                              - population
                                        google:
                                          type: object
                                          properties:
                                            address_components:
                                              type: array
                                              items:
                                                type: object
                                                properties:
                                                  long_name:
                                                    type: string
                                                  short_name:
                                                    type: string
                                                  types:
                                                    type: array
                                                    items:
                                                      type: string
                                                required:
                                                  - long_name
                                                  - short_name
                                                  - types
                                            adr_address:
                                              type: string
                                            formatted_address:
                                              type: string
                                            geometry:
                                              type: object
                                              properties:
                                                location:
                                                  type: object
                                                  properties:
                                                    lat:
                                                      type: number
                                                    lng:
                                                      type: number
                                                  required:
                                                    - lat
                                                    - lng
                                                viewport:
                                                  type: object
                                                  properties:
                                                    south:
                                                      type: number
                                                    west:
                                                      type: number
                                                    north:
                                                      type: number
                                                    east:
                                                      type: number
                                                  required:
                                                    - south
                                                    - west
                                                    - north
                                                    - east
                                              required:
                                                - location
                                                - viewport
                                            name:
                                              type: string
                                            types:
                                              type: array
                                              items:
                                                type: string
                                            utc_offset:
                                              type: integer
                                            html_attributions:
                                              type: array
                                            utc_offset_minutes:
                                              type: integer
                                          required:
                                            - address_components
                                            - adr_address
                                            - formatted_address
                                            - geometry
                                            - name
                                            - types
                                            - utc_offset
                                            - html_attributions
                                            - utc_offset_minutes
                                        _id:
                                          type: string
                                      required:
                                        - fullAddress
                                        - zipCode
                                        - coordinates
                                        - points
                                        - addressProximity
                                        - geoNames
                                        - google
                                        - _id
                                    shipping_state:
                                      type: string
                                    countryData:
                                      type: string
                                    cityData:
                                      type: string
                                    stateData:
                                      type: string
                                    description:
                                      type: string
                                    _id:
                                      type: string
                                  required:
                                    - line_1
                                    - line_2
                                    - state
                                    - city
                                    - country
                                    - zip_code
                                    - state_id
                                    - geoLocation
                                    - shipping_state
                                    - countryData
                                    - cityData
                                    - stateData
                                    - description
                                    - _id
                              email:
                                type: string
                              _id:
                                type: string
                              __v:
                                type: integer
                            required:
                              - shop
                              - full_name
                              - telephone
                              - intlTel
                              - whatsApp
                              - address
                              - email
                              - _id
                              - __v
                          customerOrderCountUpdated:
                            type: boolean
                          digital:
                            type: boolean
                          discountAmount:
                            type: integer
                          discountsApplied:
                            type: array
                          email:
                            type: string
                          intlTel:
                            type: string
                          isComplete:
                            type: boolean
                          isDraft:
                            type: boolean
                          logistics:
                            type: object
                            properties:
                              type:
                                type: string
                              rateSnapshot:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  _id:
                                    type: string
                                  name:
                                    type: string
                                  media:
                                    type: string
                                  rateType:
                                    type: string
                                  amount:
                                    type: number
                                  serviceType:
                                    type: string
                                  currency:
                                    type: string
                                  estimatedDeliveryETA:
                                    type: string
                                  estimatedPickupETA:
                                    type: string
                                  estimatedDeliveryETADateTime:
                                    type: string
                                  estimatedPickupETADateTime:
                                    type: string
                                  description:
                                    type: string
                                  courier:
                                    type: string
                                  provider:
                                    type: string
                                  type:
                                    type: string
                                  platform:
                                    type: string
                                  ratings:
                                    type: number
                                  meta:
                                    type: object
                                    properties:
                                      courier_id:
                                        type: string
                                      courier_name:
                                        type: string
                                      courier_image:
                                        type: string
                                      service_code:
                                        type: string
                                      insurance:
                                        type: object
                                        properties:
                                          code:
                                            type: string
                                          fee:
                                            type: integer
                                        required:
                                          - code
                                          - fee
                                      discount:
                                        type: object
                                        properties:
                                          percentage:
                                            type: integer
                                          symbol:
                                            type: string
                                          discounted:
                                            type: integer
                                        required:
                                          - percentage
                                          - symbol
                                          - discounted
                                      service_type:
                                        type: string
                                      waybill:
                                        type: boolean
                                      is_cod_available:
                                        type: boolean
                                      tracking_level:
                                        type: integer
                                      ratings:
                                        type: number
                                      votes:
                                        type: integer
                                      connected_account:
                                        type: boolean
                                      rate_card_amount:
                                        type: number
                                      pickup_eta:
                                        type: string
                                      pickup_eta_time:
                                        type: string
                                      dropoff_station:
                                        type: 'null'
                                      pickup_station:
                                        type: 'null'
                                      delivery_eta:
                                        type: string
                                      delivery_eta_time:
                                        type: string
                                      info:
                                        type: array
                                        items:
                                          type: string
                                      currency:
                                        type: string
                                      vat:
                                        type: integer
                                      total:
                                        type: number
                                      tracking:
                                        type: object
                                        properties:
                                          bars:
                                            type: integer
                                          label:
                                            type: string
                                        required:
                                          - bars
                                          - label
                                      token:
                                        type: string
                                    required:
                                      - courier_id
                                      - courier_name
                                      - courier_image
                                      - service_code
                                      - insurance
                                      - discount
                                      - service_type
                                      - waybill
                                      - is_cod_available
                                      - tracking_level
                                      - ratings
                                      - votes
                                      - connected_account
                                      - rate_card_amount
                                      - pickup_eta
                                      - pickup_eta_time
                                      - dropoff_station
                                      - pickup_station
                                      - delivery_eta
                                      - delivery_eta_time
                                      - info
                                      - currency
                                      - vat
                                      - total
                                      - tracking
                                      - token
                                  preferenceStatus:
                                    type: string
                                  actualAmount:
                                    type: number
                                  markup:
                                    type: integer
                                  markupMeta:
                                    type: 'null'
                                required:
                                  - id
                                  - _id
                                  - name
                                  - media
                                  - rateType
                                  - amount
                                  - serviceType
                                  - currency
                                  - estimatedDeliveryETA
                                  - estimatedPickupETA
                                  - estimatedDeliveryETADateTime
                                  - estimatedPickupETADateTime
                                  - description
                                  - courier
                                  - provider
                                  - type
                                  - platform
                                  - ratings
                                  - meta
                                  - preferenceStatus
                                  - actualAmount
                                  - markup
                                  - markupMeta
                              courier:
                                type: string
                              platform:
                                type: string
                              serviceType:
                                type: string
                              history:
                                type: array
                              paidWith:
                                type: string
                            required:
                              - type
                              - rateSnapshot
                              - courier
                              - platform
                              - serviceType
                              - history
                              - paidWith
                          modified:
                            type: string
                          notes:
                            type: string
                          paymentError:
                            type: array
                          paymentState:
                            type: string
                          paymentType:
                            type: string
                          payments:
                            type: array
                          products:
                            type: array
                            items:
                              type: object
                              properties:
                                _id:
                                  type: string
                                tags:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      _id:
                                        type: string
                                      name:
                                        type: string
                                      tempId:
                                        type: string
                                      shop:
                                        type: string
                                      __v:
                                        type: integer
                                      slug:
                                        type: string
                                      productCount:
                                        type: integer
                                      imageUrl:
                                        type: string
                                    required:
                                      - _id
                                      - name
                                      - tempId
                                      - shop
                                      - __v
                                      - slug
                                      - productCount
                                      - imageUrl
                                stock:
                                  type: integer
                                digital:
                                  type: boolean
                                media:
                                  type: string
                                media_type:
                                  type: string
                                name:
                                  type: string
                                price:
                                  type: integer
                                shop:
                                  type: string
                                sale_price:
                                  type: integer
                                __v:
                                  type: integer
                                draft:
                                  type: boolean
                                alwaysInStock:
                                  type: boolean
                                costPrice:
                                  type: integer
                                sku:
                                  type: string
                                type:
                                  type: string
                                slug:
                                  type: string
                                dimension:
                                  type: object
                                  properties:
                                    unit:
                                      type: string
                                    length:
                                      type: integer
                                    width:
                                      type: integer
                                    height:
                                      type: integer
                                  required:
                                    - unit
                                    - length
                                    - width
                                    - height
                                weight:
                                  type: object
                                  properties:
                                    base:
                                      type: object
                                      properties:
                                        unit:
                                          type: string
                                        value:
                                          type: integer
                                      required:
                                        - unit
                                        - value
                                    unit:
                                      type: string
                                    value:
                                      type: integer
                                  required:
                                    - base
                                    - unit
                                    - value
                                variantsInheritPrice:
                                  type: boolean
                                setAttributesForVariants:
                                  type: boolean
                                qty:
                                  type: integer
                                variant:
                                  type: object
                                  properties:
                                    _id:
                                      type: string
                                    price:
                                      type: integer
                                    sale_price:
                                      type: integer
                                    costPrice:
                                      type: integer
                                    stock:
                                      type: integer
                                    alwaysInStock:
                                      type: boolean
                                    isActive:
                                      type: boolean
                                    sku:
                                      type: string
                                    weight:
                                      type: object
                                      properties:
                                        base:
                                          type: object
                                          properties:
                                            unit:
                                              type: string
                                            value:
                                              type: integer
                                          required:
                                            - unit
                                            - value
                                        unit:
                                          type: string
                                        value:
                                          type: integer
                                      required:
                                        - base
                                        - unit
                                        - value
                                    media:
                                      type: string
                                    digital_download:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                        url:
                                          type: string
                                        uuid:
                                          type: string
                                        size:
                                          type: 'null'
                                        maxDownloadsPerOrder:
                                          type: 'null'
                                      required:
                                        - name
                                        - url
                                        - uuid
                                        - size
                                        - maxDownloadsPerOrder
                                    media_type:
                                      type: string
                                    dimension:
                                      type: object
                                      properties:
                                        unit:
                                          type: string
                                        length:
                                          type: integer
                                        width:
                                          type: integer
                                        height:
                                          type: integer
                                      required:
                                        - unit
                                        - length
                                        - width
                                        - height
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          label:
                                            type: string
                                          name:
                                            type: string
                                          id:
                                            type: string
                                        required:
                                          - label
                                          - name
                                          - id
                                  required:
                                    - _id
                                    - price
                                    - sale_price
                                    - costPrice
                                    - stock
                                    - alwaysInStock
                                    - isActive
                                    - sku
                                    - weight
                                    - media
                                    - digital_download
                                    - media_type
                                    - dimension
                                    - options
                                originalPrice:
                                  type: integer
                                finalPrice:
                                  type: integer
                                subTotal:
                                  type: integer
                                cartItemId:
                                  type: string
                              required:
                                - _id
                                - tags
                                - stock
                                - digital
                                - media
                                - media_type
                                - name
                                - price
                                - shop
                                - sale_price
                                - __v
                                - draft
                                - alwaysInStock
                                - costPrice
                                - sku
                                - type
                                - slug
                                - dimension
                                - weight
                                - variantsInheritPrice
                                - setAttributesForVariants
                                - qty
                                - variant
                                - originalPrice
                                - finalPrice
                                - subTotal
                                - cartItemId
                          purchaseCurrency:
                            type: object
                            properties:
                              currency:
                                type: object
                                properties:
                                  _id:
                                    type: string
                                  code:
                                    type: string
                                  symbol:
                                    type: string
                                  nationality:
                                    type: string
                                  exchangeRate:
                                    type: integer
                                  __v:
                                    type: integer
                                  minimumProcessingAmount:
                                    type: integer
                                  country:
                                    type: object
                                    properties:
                                      _id:
                                        type: string
                                      name:
                                        type: string
                                      dialCode:
                                        type: string
                                      code:
                                        type: string
                                      __v:
                                        type: integer
                                      geoId:
                                        type: string
                                      hasPostCode:
                                        type: boolean
                                      postalCodeFormat:
                                        type: string
                                      currencyCode:
                                        type: string
                                      east:
                                        type: number
                                      north:
                                        type: number
                                      south:
                                        type: number
                                      west:
                                        type: number
                                    required:
                                      - _id
                                      - name
                                      - dialCode
                                      - code
                                      - __v
                                      - geoId
                                      - hasPostCode
                                      - postalCodeFormat
                                      - currencyCode
                                      - east
                                      - north
                                      - south
                                      - west
                                  name:
                                    type: string
                                required:
                                  - _id
                                  - code
                                  - symbol
                                  - nationality
                                  - exchangeRate
                                  - __v
                                  - minimumProcessingAmount
                                  - country
                                  - name
                              snapshot:
                                type: object
                                properties:
                                  baseRate:
                                    type: integer
                                  currencyRate:
                                    type: integer
                                  isBaseCurrency:
                                    type: boolean
                                  isStoreFrontDefault:
                                    type: boolean
                                required:
                                  - baseRate
                                  - currencyRate
                                  - isBaseCurrency
                                  - isStoreFrontDefault
                              amount:
                                type: number
                              shipping:
                                type: number
                              shippingMarkupAmount:
                                type: integer
                            required:
                              - currency
                              - snapshot
                              - amount
                              - shipping
                              - shippingMarkupAmount
                          shipping:
                            type: number
                          shippingMarkupAmount:
                            type: integer
                          shop:
                            type: string
                          source:
                            type: string
                          status:
                            type: object
                            properties:
                              _id:
                                type: string
                              key:
                                type: string
                              name:
                                type: string
                              notes:
                                type: string
                              isSystemStatus:
                                type: boolean
                              stage:
                                type: object
                                properties:
                                  _id:
                                    type: string
                                  name:
                                    type: string
                                  key:
                                    type: string
                                  step:
                                    type: integer
                                  __v:
                                    type: integer
                                required:
                                  - _id
                                  - name
                                  - key
                                  - step
                                  - __v
                              orderStatusActionOnUpdate:
                                type: integer
                            required:
                              - _id
                              - key
                              - name
                              - notes
                              - isSystemStatus
                              - stage
                              - orderStatusActionOnUpdate
                          subTotal:
                            type: integer
                          telephone:
                            type: string
                          total:
                            type: number
                          user:
                            type: string
                          whatsApp:
                            type: boolean
                          paymentInfo:
                            type: object
                            properties:
                              bankAccounts:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    accountName:
                                      type: string
                                    accountNumber:
                                      type: string
                                    bankName:
                                      type: string
                                    country:
                                      type: object
                                      properties:
                                        _id:
                                          type: string
                                        name:
                                          type: string
                                        dialCode:
                                          type: string
                                        code:
                                          type: string
                                        __v:
                                          type: integer
                                        geoId:
                                          type: string
                                        hasPostCode:
                                          type: boolean
                                        postalCodeFormat:
                                          type: string
                                        currencyCode:
                                          type: string
                                        east:
                                          type: number
                                        north:
                                          type: number
                                        south:
                                          type: number
                                        west:
                                          type: number
                                      required:
                                        - _id
                                        - name
                                        - dialCode
                                        - code
                                        - __v
                                        - geoId
                                        - hasPostCode
                                        - postalCodeFormat
                                        - currencyCode
                                        - east
                                        - north
                                        - south
                                        - west
                                  required:
                                    - accountName
                                    - accountNumber
                                    - bankName
                                    - country
                              description:
                                type: string
                              action:
                                type: string
                              type:
                                type: string
                              canConfirmPayment:
                                type: boolean
                              shippingPaidWith:
                                type: string
                              created:
                                type: string
                              _total:
                                type: number
                            required:
                              - bankAccounts
                              - description
                              - action
                              - type
                              - canConfirmPayment
                              - shippingPaidWith
                              - created
                              - _total
                          paymentRef:
                            type: object
                            properties:
                              type:
                                type: string
                              transactionId:
                                type: 'null'
                            required:
                              - type
                              - transactionId
                        required:
                          - _id
                          - orderNo
                          - __v
                          - amountSaved
                          - created
                          - customer
                          - customerOrderCountUpdated
                          - digital
                          - discountAmount
                          - discountsApplied
                          - email
                          - intlTel
                          - isComplete
                          - isDraft
                          - logistics
                          - modified
                          - notes
                          - paymentError
                          - paymentState
                          - paymentType
                          - payments
                          - products
                          - purchaseCurrency
                          - shipping
                          - shippingMarkupAmount
                          - shop
                          - source
                          - status
                          - subTotal
                          - telephone
                          - total
                          - user
                          - whatsApp
                          - paymentInfo
                          - paymentRef
                  success:
                    type: boolean
                required:
                  - msg
                  - data
                  - success
          description: ''

````