Get Product Locations

Changed on
get/products/location

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/products/location
  • Auth
    API key in header x-api-key

Query parameters

pageinteger
countinteger
sort'DESC' | 'ASC'
sort_by'display_order' | 'created_at'
filter.keywordstring

For search (includes only location_name, location_description)

filter.consider_rolestring

Response

200

typestring
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "location_access": "USERS",
      "allowed_users": [
        {
          "user_uid": "fea19530-406f-11e8-b99a-59f39b812a88",
          "first_name": "Henry",
          "last_name": "Jones",
          "email": "user@zuper.co",
          "home_phone_number": "1234567890",
          "designation": "Devt",
          "emp_code": "11345",
          "work_phone_number": "1234567890",
          "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/b7b1dab9-a583-498c-b41a-7584a1436622.jpg",
          "hourly_labor_charge": 99.99,
          "is_active": true,
          "created_at": "2018-04-15T05:43:59.000Z",
          "updated_at": "2024-09-13T08:07:30.000Z"
        }
      ],
      "location_type": "WAREHOUSE",
      "location_name": "123",
      "location_uid": "893005f0-eb7c-11eb-b156-7dd89e71c7c5",
      "created_by": {
        "user_uid": "02b090ba-70a9-4b97-b5f3-e8015720de13",
        "first_name": "Gayathri",
        "last_name": "S",
        "email": "user@zuper.co",
        "designation": "Frontend",
        "emp_code": "14789",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
        "hourly_labor_charge": 20,
        "is_active": true,
        "created_at": "2020-04-08T05:12:22.000Z",
        "updated_at": "2023-04-06T11:09:27.000Z"
      },
      "location_address": {
        "city": "Chennai ",
        "state": "Tamil Nadu ",
        "street": "Elango Nagar ",
        "country": "India",
        "zip_code": "600041"
      },
      "id": "undefined"
    }
  ],
  "total_records": 3,
  "current_page": 1,
  "total_pages": 1
}

Changes