users

Arguments

Argument	Type	Required	Description
`customer_account_id`	`String`	No	If you are a 3PL you can specify one of your customer's account
`search`	`String`	No	Text search on first name, last name, or email
`default_warehouse_id`	`String`	No	Only include users with this default warehouse id
`is_active`	`Boolean`	No	Only include users with this app user active status
`is_developer`	`Boolean`	No	Filter users by developer status
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

UsersQueryResult

Query

query users(
  $customer_account_id: String,
  $search: String,
  $default_warehouse_id: String,
  $is_active: Boolean,
  $is_developer: Boolean,
  $analyze: Boolean
) {
  users(
    customer_account_id: $customer_account_id,
    search: $search,
    default_warehouse_id: $default_warehouse_id,
    is_active: $is_active,
    is_developer: $is_developer,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...UserConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...UserEdgeFragment
      
        node {
          ...UserFragment
        
          id
          legacy_id
          email
          first_name
          last_name
          created_at
          updated_at
          is_admin
          profile_image
          default_picking_option
          position
          hourly_rate
          payroll_id
          default_order_status
          default_warehouse_id
          is_active
          is_developer
          default_pick_order_tag
          account {
            ...AccountFragment
          
            id
            legacy_id
            email
            username
            status
            dynamic_slotting
            is_multi_warehouse
            is_3pl
            cycle_count_enabled
            ship_backorders
            customers {
              ...AccountConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...AccountEdgeFragment
              
                node {
                  ...AccountFragment
                }
                cursor
              }
            }
            warehouses {
              ...WarehouseFragment
            
              id
              legacy_id
              account_id
              identifier
              dynamic_slotting
              invoice_email
              phone_number
              profile
              address {
                ...AddressFragment
              
                name
                address1
                address2
                city
                state
                country
                zip
                phone
              }
              return_address {
                ...AddressFragment
              
                name
                address1
                address2
                city
                state
                country
                zip
                phone
              }
              company_name
              company_alias
              active
              products {
                ...ProductConnectionFragment
              
                pageInfo {
                  ...PageInfoFragment
                
                  hasNextPage
                  hasPreviousPage
                  startCursor
                  endCursor
                }
                edges {
                  ...ProductEdgeFragment
                
                  node {
                    ...ProductFragment
                  
                    id
                    legacy_id
                    account_id
                    name
                    sku
                    price
                    value
                    value_currency
                    barcode
                    country_of_manufacture
                    dimensions {
                      ...DimensionsFragment
                    }
                    tariff_code
                    kit
                    kit_build
                    no_air
                    final_sale
                    customs_value
                    customs_description
                    not_owned
                    dropship
                    needs_serial_number
                    thumbnail
                    large_thumbnail
                    created_at
                    updated_at
                    product_note
                    virtual
                    ignore_on_invoice
                    ignore_on_customs
                    active
                    needs_lot_tracking
                    packer_note
                    size
                    style
                    vendor_part_number
                    consumer_package_code
                    buyer_part_number
                    buyer_style_number
                    auto_pack
                    warehouse_products {
                      ...WarehouseProductFragment
                    }
                    fba_inventory {
                      ...FbaInventoryFragment
                    }
                    images {
                      ...ProductImageFragment
                    }
                    tags
                    vendors {
                      ...ProductVendorFragment
                    }
                    components {
                      ...ProductFragment
                    }
                    kit_components {
                      ...KitComponentFragment
                    }
                    cases {
                      ...CaseFragment
                    }
                  }
                  cursor
                }
              }
            }
          }
          allowed_warehouses {
            ...WarehouseFragment
          
            id
            legacy_id
            account_id
            identifier
            dynamic_slotting
            invoice_email
            phone_number
            profile
            address {
              ...AddressFragment
            
              name
              address1
              address2
              city
              state
              country
              zip
              phone
            }
            return_address {
              ...AddressFragment
            
              name
              address1
              address2
              city
              state
              country
              zip
              phone
            }
            company_name
            company_alias
            active
            products {
              ...ProductConnectionFragment
            
              pageInfo {
                ...PageInfoFragment
              
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                ...ProductEdgeFragment
              
                node {
                  ...ProductFragment
                
                  id
                  legacy_id
                  account_id
                  name
                  sku
                  price
                  value
                  value_currency
                  barcode
                  country_of_manufacture
                  dimensions {
                    ...DimensionsFragment
                  
                    weight
                    height
                    width
                    length
                  }
                  tariff_code
                  kit
                  kit_build
                  no_air
                  final_sale
                  customs_value
                  customs_description
                  not_owned
                  dropship
                  needs_serial_number
                  thumbnail
                  large_thumbnail
                  created_at
                  updated_at
                  product_note
                  virtual
                  ignore_on_invoice
                  ignore_on_customs
                  active
                  needs_lot_tracking
                  packer_note
                  size
                  style
                  vendor_part_number
                  consumer_package_code
                  buyer_part_number
                  buyer_style_number
                  auto_pack
                  warehouse_products {
                    ...WarehouseProductFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    warehouse_id
                    warehouse_identifier
                    price
                    value
                    value_currency
                    on_hand
                    inventory_bin
                    inventory_overstock_bin
                    reserve_inventory
                    replenishment_level
                    replenishment_max_level
                    replenishment_increment
                    reorder_amount
                    reorder_level
                    backorder
                    allocated
                    available
                    non_sellable_quantity
                    in_tote
                    custom
                    customs_value
                    created_at
                    updated_at
                    sell_ahead
                    active
                    warehouse {
                      ...WarehouseFragment
                    }
                    product {
                      ...ProductFragment
                    }
                    inbounds {
                      ...WarehouseProductInboundConnectionFragment
                    }
                    locations {
                      ...ItemLocationConnectionFragment
                    }
                  }
                  fba_inventory {
                    ...FbaInventoryFragment
                  
                    id
                    legacy_id
                    quantity
                    marketplace_id
                    merchant_id
                  }
                  images {
                    ...ProductImageFragment
                  
                    src
                    position
                  }
                  tags
                  vendors {
                    ...ProductVendorFragment
                  
                    vendor_id
                    vendor_sku
                    price
                  }
                  components {
                    ...ProductFragment
                  }
                  kit_components {
                    ...KitComponentFragment
                  
                    id
                    legacy_id
                    account_id
                    sku
                    quantity
                  }
                  cases {
                    ...CaseFragment
                  
                    id
                    legacy_id
                    case_barcode
                    case_quantity
                  }
                }
                cursor
              }
            }
          }
          stores {
            ...StoreFragment
          
            id
            legacy_id
            shop_name
          }
        }
        cursor
      }
    }
  }
}

Variables

{
  "customer_account_id": "abc123",
  "search": "abc123",
  "default_warehouse_id": "abc123",
  "is_active": true,
  "is_developer": true,
  "analyze": true
}

Response

{
  "data": {
    "users": {
      "request_id": "abc123",
      "complexity": 987,
      "data": UserConnection
    }
  }
}