Skip to main content
POST
/
{shopId}
/
orders
/
admin
Create admin order
curl --request POST \
  --url http://staging.qshop.ng/apiv2/{shopId}/orders/admin \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": "6273c2f8c4094d0dfe74ac78",
  "deliveryType": "delivery",
  "digital": false,
  "discountAmount": "100",
  "isDraft": true,
  "items": [
    {
      "_id": "62eaba0b33650510114a82f5",
      "qty": 1,
      "variant": {
        "_id": "62eaba0b33650510114a82f3"
      }
    }
  ],
  "notes": "Quick delivery",
  "paymentMethod": "POS",
  "paymentState": "paid",
  "pickUpLocation": "62d351a161c265a117704142",
  "regionName": null,
  "sendNotification": true,
  "shipping": "1000",
  "shippingDetails": {
    "address": "5 East park avenue",
    "city": "Ikeja",
    "cityId": "62d46bb079344c34996b2c40",
    "country": "Nigeria",
    "countryId": "628c8d3c21ce8313e6293c8e",
    "geoLocation": {
      "addressProximity": "close",
      "coordinates": {
        "lat": 6.820255299999999,
        "lng": 3.4486531
      },
      "fullAddress": "Unity close, Off Redemption Way, 110113, Mowe, Nigeria",
      "geoNames": [
        {
          "adminName1": "",
          "fcl": "L",
          "fclName": "parks,area, ...",
          "fcode": "AREA",
          "fcodeName": "area",
          "geonameId": 6295630,
          "lat": "0",
          "lng": "0",
          "name": "Earth",
          "population": 6814400000,
          "toponymName": "Earth"
        },
        {
          "adminName1": "",
          "fcl": "L",
          "fclName": "parks,area, ...",
          "fcode": "CONT",
          "fcodeName": "continent",
          "geonameId": 6255146,
          "lat": "7.1881",
          "lng": "21.09375",
          "name": "Africa",
          "population": 1031833000,
          "toponymName": "Africa"
        },
        {
          "adminCode1": "00",
          "adminName1": "",
          "countryCode": "NG",
          "countryId": "2328926",
          "countryName": "Nigeria",
          "fcl": "A",
          "fclName": "country, state, region,...",
          "fcode": "PCLI",
          "fcodeName": "independent political entity",
          "geonameId": 2328926,
          "lat": "10",
          "lng": "8",
          "name": "Nigeria",
          "population": 195874740,
          "toponymName": "Federal Republic of Nigeria"
        },
        {
          "adminCode1": "16",
          "adminCodes1": {
            "ISO3166_2": "OG"
          },
          "adminName1": "Ogun",
          "countryCode": "NG",
          "countryId": "2328926",
          "countryName": "Nigeria",
          "fcl": "A",
          "fclName": "country, state, region,...",
          "fcode": "ADM1",
          "fcodeName": "first-order administrative division",
          "geonameId": 2327546,
          "lat": "7",
          "lng": "3.58333",
          "name": "Ogun State",
          "population": 4054272,
          "toponymName": "Ogun State"
        },
        {
          "adminCode1": "16",
          "adminCodes1": {
            "ISO3166_2": "OG"
          },
          "adminName1": "Ogun",
          "countryCode": "NG",
          "countryId": "2328926",
          "countryName": "Nigeria",
          "fcl": "A",
          "fclName": "country, state, region,...",
          "fcode": "ADM2",
          "fcodeName": "second-order administrative division",
          "geonameId": 7873905,
          "lat": "6.96907",
          "lng": "3.48404",
          "name": "Obafemi Owode",
          "population": 0,
          "toponymName": "Obafemi Owode"
        },
        {
          "adminCode1": "16",
          "adminCodes1": {
            "ISO3166_2": "OG"
          },
          "adminName1": "Ogun",
          "countryCode": "NG",
          "countryId": "2328926",
          "countryName": "Nigeria",
          "fcl": "P",
          "fclName": "city, village,...",
          "fcode": "PPL",
          "fcodeName": "populated place",
          "geonameId": 2331967,
          "lat": "6.82191",
          "lng": "3.45153",
          "name": "Loburo",
          "population": 0,
          "toponymName": "Loburo"
        }
      ],
      "google": {
        "address_components": [
          {
            "long_name": "Off",
            "short_name": "Off",
            "types": [
              "street_number"
            ]
          },
          {
            "long_name": "Redemption Way",
            "short_name": "Redemption Way",
            "types": [
              "route"
            ]
          },
          {
            "long_name": "Mowe",
            "short_name": "Mowe",
            "types": [
              "locality",
              "political"
            ]
          },
          {
            "long_name": "Obafemi Owode",
            "short_name": "Obafemi Owode",
            "types": [
              "administrative_area_level_2",
              "political"
            ]
          },
          {
            "long_name": "Ogun State",
            "short_name": "OG",
            "types": [
              "administrative_area_level_1",
              "political"
            ]
          },
          {
            "long_name": "Nigeria",
            "short_name": "NG",
            "types": [
              "country",
              "political"
            ]
          },
          {
            "long_name": "110113",
            "short_name": "110113",
            "types": [
              "postal_code"
            ]
          }
        ],
        "adr_address": "Unity close, <span class=\"street-address\">Off Redemption Way</span>, <span class=\"postal-code\">110113</span>, <span class=\"locality\">Mowe</span>, <span class=\"country-name\">Nigeria</span>",
        "formatted_address": "Unity close, Off Redemption Way, 110113, Mowe, Nigeria",
        "geometry": {
          "location": {
            "lat": 6.820255299999999,
            "lng": 3.4486531
          },
          "viewport": {
            "east": 3.449958680291502,
            "north": 6.821616580291503,
            "south": 6.818918619708499,
            "west": 3.447260719708498
          }
        },
        "html_attributions": [],
        "name": "Loburo",
        "types": [
          "school",
          "point_of_interest",
          "establishment"
        ],
        "utc_offset": 60,
        "utc_offset_minutes": 60
      },
      "zipCode": "110113"
    },
    "region": "MAINLAND",
    "regionId": "MA9032890",
    "state": "Lagos",
    "stateId": "62c80815c9d738e14b8988e6",
    "zipCode": ""
  },
  "status": "processing",
  "whatsApp": false
}
'

Body

application/json
customer
string
Example:

"6273c2f8c4094d0dfe74ac78"

deliveryType
string
Example:

"delivery"

digital
boolean
Example:

false

discountAmount
string
Example:

"100"

isDraft
boolean
Example:

true

items
object[]
Example:
[
{
"_id": "62eaba0b33650510114a82f5",
"qty": 1,
"variant": { "_id": "62eaba0b33650510114a82f3" }
}
]
notes
string
Example:

"Quick delivery"

paymentMethod
string
Example:

"POS"

paymentState
string
Example:

"paid"

pickUpLocation
string
Example:

"62d351a161c265a117704142"

regionName
unknown
sendNotification
boolean
Example:

true

shipping
string
Example:

"1000"

shippingDetails
object
status
string
Example:

"processing"

whatsApp
boolean
Example:

false

Response

200 - undefined