Update user new - QShop API Documentation

Update User new

curl --request PATCH \
  --url http://staging.qshop.ng/apiv2/{user_id}/update \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "full_name": "Louief",
  "telephone": "+2348137064736"
}
'

{
  "data": {
    "email": "[email protected]",
    "full_name": "Louief",
    "id": "629e06ac81da717af2ed2b98",
    "isAdmin": true,
    "last_access": "2022-06-06T13:53:37.800Z",
    "reg_date": "2022-06-06T13:53:37.800Z",
    "reset_pass": true,
    "roles": [
      {
        "_id": "5e7e89bf872c2c0f8c1c3fb4",
        "isAdmin": true,
        "isSuperAdmin": false,
        "name": "Shop Admin"
      }
    ],
    "shop": {
      "__v": 2,
      "_id": "5f3ef405c072de214d9d6703",
      "billingNotice": "2020-08-27T08:00:00.364Z",
      "bio": "Best uk used phone shop",
      "call": true,
      "created": "2020-08-20T22:07:01.725Z",
      "currencies": [],
      "email": "[email protected]",
      "inventoryConfig": {
        "displayOptionKeyId": "6c6f775f696e5f73746f636b",
        "enableProductPageStockCount": false,
        "isLowStockEnabled": false,
        "isOutOfStockEnabled": false
      },
      "locations": [],
      "logo": "5f3ef405c072de214d9d6702-inbound3469806257505107320.jpg",
      "modified": "2020-08-20T22:07:01.725Z",
      "name": "I sell phones and laptop",
      "owner": {
        "__v": 0,
        "_id": "5f3ef3c8c072de214d9d6701",
        "email": "[email protected]",
        "full_name": "Arinze Esomnofu",
        "last_access": "2021-08-11T09:14:41.759Z",
        "pass": "$2b$10$dmOPpIxa7dlfCYCbiMYWiueO2JWfQ9VcqynlIYfTlRu5RWCD9hDre",
        "profiles": [],
        "referred_by": "5f3c62f4bc19938f1ad2e212",
        "reg_date": "2020-08-20T22:06:00.935Z",
        "reset_pass": false,
        "roles": [
          "5e7e89bf872c2c0f8c1c3fb4"
        ],
        "shopCount": 1,
        "social": [],
        "telephone": "+2348031391676",
        "username": "[email protected]"
      },
      "paymentError": [],
      "paymentMethods": [],
      "productWeightConfig": {
        "unit": "kg"
      },
      "products": 1,
      "shippingRates": [
        {
          "_id": "5ee6a2f6eea46308e8f84863",
          "countryCode": "NG",
          "disableShipping": false,
          "enableShipping": true,
          "name": "Rivers",
          "rate": "4000"
        }
      ],
      "shopCategory": {
        "_id": "5f3c62287fe78f559ccf7793",
        "name": "Phones & Tablets",
        "weight": 140
      },
      "shopPreview": "2020-08-28T11:42:09.730Z",
      "slug": "i-sell-phones-and-laptop",
      "status": "pending",
      "telephone": "+2348031391676",
      "theme": "MINIMAL",
      "whatsApp": true
    },
    "shopCount": 0,
    "telephone": "+2348137064736",
    "test_user": false,
    "username": "[email protected]"
  },
  "message": "User updated successfully",
  "status": 200,
  "success": true
}

PATCH

{user_id}

update

Update User new

curl --request PATCH \
  --url http://staging.qshop.ng/apiv2/{user_id}/update \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "full_name": "Louief",
  "telephone": "+2348137064736"
}
'

{
  "data": {
    "email": "[email protected]",
    "full_name": "Louief",
    "id": "629e06ac81da717af2ed2b98",
    "isAdmin": true,
    "last_access": "2022-06-06T13:53:37.800Z",
    "reg_date": "2022-06-06T13:53:37.800Z",
    "reset_pass": true,
    "roles": [
      {
        "_id": "5e7e89bf872c2c0f8c1c3fb4",
        "isAdmin": true,
        "isSuperAdmin": false,
        "name": "Shop Admin"
      }
    ],
    "shop": {
      "__v": 2,
      "_id": "5f3ef405c072de214d9d6703",
      "billingNotice": "2020-08-27T08:00:00.364Z",
      "bio": "Best uk used phone shop",
      "call": true,
      "created": "2020-08-20T22:07:01.725Z",
      "currencies": [],
      "email": "[email protected]",
      "inventoryConfig": {
        "displayOptionKeyId": "6c6f775f696e5f73746f636b",
        "enableProductPageStockCount": false,
        "isLowStockEnabled": false,
        "isOutOfStockEnabled": false
      },
      "locations": [],
      "logo": "5f3ef405c072de214d9d6702-inbound3469806257505107320.jpg",
      "modified": "2020-08-20T22:07:01.725Z",
      "name": "I sell phones and laptop",
      "owner": {
        "__v": 0,
        "_id": "5f3ef3c8c072de214d9d6701",
        "email": "[email protected]",
        "full_name": "Arinze Esomnofu",
        "last_access": "2021-08-11T09:14:41.759Z",
        "pass": "$2b$10$dmOPpIxa7dlfCYCbiMYWiueO2JWfQ9VcqynlIYfTlRu5RWCD9hDre",
        "profiles": [],
        "referred_by": "5f3c62f4bc19938f1ad2e212",
        "reg_date": "2020-08-20T22:06:00.935Z",
        "reset_pass": false,
        "roles": [
          "5e7e89bf872c2c0f8c1c3fb4"
        ],
        "shopCount": 1,
        "social": [],
        "telephone": "+2348031391676",
        "username": "[email protected]"
      },
      "paymentError": [],
      "paymentMethods": [],
      "productWeightConfig": {
        "unit": "kg"
      },
      "products": 1,
      "shippingRates": [
        {
          "_id": "5ee6a2f6eea46308e8f84863",
          "countryCode": "NG",
          "disableShipping": false,
          "enableShipping": true,
          "name": "Rivers",
          "rate": "4000"
        }
      ],
      "shopCategory": {
        "_id": "5f3c62287fe78f559ccf7793",
        "name": "Phones & Tablets",
        "weight": 140
      },
      "shopPreview": "2020-08-28T11:42:09.730Z",
      "slug": "i-sell-phones-and-laptop",
      "status": "pending",
      "telephone": "+2348031391676",
      "theme": "MINIMAL",
      "whatsApp": true
    },
    "shopCount": 0,
    "telephone": "+2348137064736",
    "test_user": false,
    "username": "[email protected]"
  },
  "message": "User updated successfully",
  "status": 200,
  "success": true
}

Path Parameters

user_id

string

required

Example:

"629e06ac81da717af2ed2b98"

Body

application/json

string

Example:

"[email protected]"

full_name

string

Example:

"Louief"

telephone

string

Example:

"+2348137064736"

Response

200 - application/json

200

data

object

Show child attributes

data.email

string

Example:

"[email protected]"

data.full_name

string

Example:

"Louief"

data.id

string

Example:

"629e06ac81da717af2ed2b98"

data.isAdmin

boolean

Example:

true

data.last_access

string

Example:

"2022-06-06T13:53:37.800Z"

data.reg_date

string

Example:

"2022-06-06T13:53:37.800Z"

data.reset_pass

boolean

Example:

true

data.roles

object[]

Show child attributes

data.roles._id

string

Example:

"5e7e89bf872c2c0f8c1c3fb4"

data.roles.isAdmin

boolean

Example:

true

data.roles.isSuperAdmin

boolean

Example:

false

data.roles.name

string

Example:

"Shop Admin"

Example:

[
  {
    "_id": "5e7e89bf872c2c0f8c1c3fb4",
    "isAdmin": true,
    "isSuperAdmin": false,
    "name": "Shop Admin"
  }
]

data.shop

object

Show child attributes

data.shop.__v

number

Example:

2

data.shop._id

string

Example:

"5f3ef405c072de214d9d6703"

data.shop.billingNotice

string

Example:

"2020-08-27T08:00:00.364Z"

data.shop.bio

string

Example:

"Best uk used phone shop"

data.shop.call

boolean

Example:

true

data.shop.created

string

Example:

"2020-08-20T22:07:01.725Z"

data.shop.currencies

any[]

Example:

[]

data.shop.email

string

Example:

"[email protected]"

data.shop.inventoryConfig

object

Show child attributes

data.shop.inventoryConfig.displayOptionKeyId

string

Example:

"6c6f775f696e5f73746f636b"

data.shop.inventoryConfig.enableProductPageStockCount

boolean

Example:

false

data.shop.inventoryConfig.isLowStockEnabled

boolean

Example:

false

data.shop.inventoryConfig.isOutOfStockEnabled

boolean

Example:

false

data.shop.locations

any[]

Example:

[]

data.shop.logo

string

Example:

"5f3ef405c072de214d9d6702-inbound3469806257505107320.jpg"

data.shop.modified

string

Example:

"2020-08-20T22:07:01.725Z"

data.shop.name

string

Example:

"I sell phones and laptop"

data.shop.owner

object

Show child attributes

data.shop.owner.__v

number

Example:

0

data.shop.owner._id

string

Example:

"5f3ef3c8c072de214d9d6701"

data.shop.owner.email

string

Example:

"[email protected]"

data.shop.owner.full_name

string

Example:

"Arinze Esomnofu"

data.shop.owner.last_access

string

Example:

"2021-08-11T09:14:41.759Z"

data.shop.owner.pass

string

Example:

"$2b$10$dmOPpIxa7dlfCYCbiMYWiueO2JWfQ9VcqynlIYfTlRu5RWCD9hDre"

data.shop.owner.profiles

any[]

Example:

[]

data.shop.owner.referred_by

string

Example:

"5f3c62f4bc19938f1ad2e212"

data.shop.owner.reg_date

string

Example:

"2020-08-20T22:06:00.935Z"

data.shop.owner.reset_pass

boolean

Example:

false

data.shop.owner.roles

string[]

Example:

["5e7e89bf872c2c0f8c1c3fb4"]

data.shop.owner.shopCount

number

Example:

1

Example:

[]

data.shop.owner.telephone

string

Example:

"+2348031391676"

data.shop.owner.username

string

Example:

"[email protected]"

data.shop.paymentError

any[]

Example:

[]

data.shop.paymentMethods

any[]

Example:

[]

data.shop.productWeightConfig

object

Show child attributes

data.shop.productWeightConfig.unit

string

Example:

"kg"

data.shop.products

number

Example:

1

data.shop.shippingRates

object[]

Show child attributes

data.shop.shippingRates._id

string

Example:

"5ee6a2f6eea46308e8f84863"

data.shop.shippingRates.countryCode

string

Example:

"NG"

data.shop.shippingRates.disableShipping

boolean

Example:

false

data.shop.shippingRates.enableShipping

boolean

Example:

true

data.shop.shippingRates.name

string

Example:

"Rivers"

data.shop.shippingRates.rate

string

Example:

"4000"

Example:

[
  {
    "_id": "5ee6a2f6eea46308e8f84863",
    "countryCode": "NG",
    "disableShipping": false,
    "enableShipping": true,
    "name": "Rivers",
    "rate": "4000"
  }
]

data.shop.shopCategory

object

Show child attributes

data.shop.shopCategory._id

string

Example:

"5f3c62287fe78f559ccf7793"

data.shop.shopCategory.name

string

Example:

"Phones & Tablets"

data.shop.shopCategory.weight

number

Example:

140

data.shop.shopPreview

string

Example:

"2020-08-28T11:42:09.730Z"

data.shop.slug

string

Example:

"i-sell-phones-and-laptop"

data.shop.status

string

Example:

"pending"

data.shop.telephone

string

Example:

"+2348031391676"

data.shop.theme

string

Example:

"MINIMAL"

data.shop.whatsApp

boolean

Example:

true

data.shopCount

number

Example:

0

data.telephone

string

Example:

"+2348137064736"

data.test_user

boolean

Example:

false

data.username

string

Example:

"[email protected]"

message

string

Example:

"User updated successfully"

status

number

Example:

200

success

boolean

Example:

true

Update shop slug Request kyc

⌘I